Skip to content

Commit

Permalink
Add example github URL to boilerplate README
Browse files Browse the repository at this point in the history
  • Loading branch information
neoformit committed Jan 20, 2025
1 parent 61200c9 commit de276fe
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions app/labs/templates/labs/bootstrap/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# What to do next?

1. Copy this Lab content folder to a public-facing Github repository.
1. On GitHub, navigate to the root of your Lab content folder and copy the URL -
we will refer to this as `MY-GITHUB-URL`.
1. View your Lab page in real time by visiting:
https://labs.usegalaxy.org.au/content_root=`MY-GITHUB-URL/base.yml`
1. Update the content of the Lab by editing the files in your repository on Github.
1. To view updated content, you must disable caching with an extra URL parameter:
https://labs.usegalaxy.org.au/content_root=`MY-GITHUB-URL/base.yml&cache=false`
1. You can switch between different Galaxy server's versions of the page by
2. On GitHub, navigate to the root of your Lab content folder and copy the URL -
we will refer to this as `MY-GITHUB-URL`. e.g.
https://github.com/mygithubuser/my-repo-name/blob/main/base.yml
3. View your Lab page in real time by visiting:
https://labs.usegalaxy.org.au/?content_root=`MY-GITHUB-URL/base.yml`
4. Update the content of the Lab by editing the files in your repository on Github.
5. To view updated content, you must disable caching with an extra URL parameter:
https://labs.usegalaxy.org.au/?content_root=`MY-GITHUB-URL/base.yml&cache=false`
6. You can switch between different Galaxy server's versions of the page by
pointing to the server's YAML file e.g. `MY-GITHUB-URL/usegalaxy.eu.yml`.
1. When writing HTML/Markdown Lab content, try to use the variables defined in
7. When writing HTML/Markdown Lab content, try to use the variables defined in
`base.yml` as much as possible, for example `Welcome to Galaxy Europe!`,
should be written like `Welcome to Galaxy {{ site_name }}!`
1. Any variables that you add to `base.yml` or `<server>.yml` can be referenced in
8. Any variables that you add to `base.yml` or `<server>.yml` can be referenced in
Markdown/HTML!

For full docs on building a Lab page, go to https://labs.usegalaxy.org.au/.

0 comments on commit de276fe

Please sign in to comment.