Skip to content

Commit

Permalink
Rename all main.yml to base.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
neoformit committed Aug 12, 2024
1 parent 74edcf9 commit fea6678
Show file tree
Hide file tree
Showing 11 changed files with 19 additions and 22 deletions.
4 changes: 2 additions & 2 deletions webapp/home/lab_export.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
"""Exported landing pages to be requested by external Galaxy servers.
Example with local YAML:
http://127.0.0.1:8000/landing/export?content_root=http://127.0.0.1:8000/static/home/labs/genome/main.yml
http://127.0.0.1:8000/landing/export?content_root=http://127.0.0.1:8000/static/home/labs/genome/base.yml
Example URL with remote YAML:
http://127.0.0.1:8000/landing/export?content_root=https://raw.githubusercontent.com/usegalaxy-au/galaxy-media-site/dev/webapp/home/static/home/labs/genome/main.yml
http://127.0.0.1:8000/landing/export?content_root=https://raw.githubusercontent.com/usegalaxy-au/galaxy-media-site/dev/webapp/home/static/home/labs/genome/base.yml
"""

Expand Down
2 changes: 1 addition & 1 deletion webapp/home/labs/docs/base.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Default spec for an exported subsite landing page

# You can test with: /lab/export?content_root=https://raw.githubusercontent.com/usegalaxy-au/galaxy-media-site/dev/webapp/home/labs/docs/main.yml
# You can test with: /lab/export?content_root=https://raw.githubusercontent.com/usegalaxy-au/galaxy-media-site/dev/webapp/home/labs/docs/base.yml

site_name: Antarctica
lab_name: Galaxy Lab Pages
Expand Down
1 change: 0 additions & 1 deletion webapp/home/labs/docs/main.yml

This file was deleted.

18 changes: 9 additions & 9 deletions webapp/home/labs/docs/templates/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
</li>
<li>
See a full working example of an exported Galaxy Lab page
<a href="/lab/export?content_root=http://{{ HOSTNAME }}/static/home/labs/genome/main.yml">here</a>.
<a href="/lab/export?content_root=http://{{ HOSTNAME }}/static/home/labs/genome/base.yml">here</a>.
</li>
<li>
See a minimal working example of a lab page
<a href="/lab/export?content_root=http://{{ HOSTNAME }}/static/home/labs/simple/main.yml">here</a>.
<a href="/lab/export?content_root=http://{{ HOSTNAME }}/static/home/labs/simple/base.yml">here</a>.
</li>
</ul>

Expand Down Expand Up @@ -48,8 +48,8 @@ <h2 class="accordion-header" id="headingOne">
<ul>
<li>
The root of your site's content should be a YAML file - see
<a href="https://github.com/usegalaxy-au/galaxy-media-site/tree/dev/webapp/home/labs/docs/main.yml" target="_blank">
main.yml
<a href="https://github.com/usegalaxy-au/galaxy-media-site/tree/dev/webapp/home/labs/docs/base.yml" target="_blank">
base.yml
</a>
for the content root of this page.
</li>
Expand All @@ -59,16 +59,16 @@ <h2 class="accordion-header" id="headingOne">
For example, we can explicitly request this page with:
<br>
<small>
<a href="/lab/export?content_root=https://raw.githubusercontent.com/usegalaxy-au/galaxy-media-site/dev/webapp/home/labs/docs/main.yml" target="_blank">
http://{{ HOSTNAME }}/lab/export?content_root=https://raw.githubusercontent.com/usegalaxy-au/galaxy-media-site/dev/webapp/home/labs/docs/main.yml
<a href="/lab/export?content_root=https://raw.githubusercontent.com/usegalaxy-au/galaxy-media-site/dev/webapp/home/labs/docs/base.yml" target="_blank">
http://{{ HOSTNAME }}/lab/export?content_root=https://raw.githubusercontent.com/usegalaxy-au/galaxy-media-site/dev/webapp/home/labs/docs/base.yml
</a>
</small>
</li>
<li>
The web server will fetch your content from GitHub (or anywhere on the internet) and render it into this page.
</li>
<li>
Note that <code>main.yml</code> points to other files (YAML, HTML, CSS and images), which are located in the same remote directory (e.g. on GitHub). You can template the entire page with these files!
Note that <code>base.yml</code> points to other files (YAML, HTML, CSS and images), which are located in the same remote directory (e.g. on GitHub). You can template the entire page with these files!
</li>
<li>
The most useful part of this machinery is the <code>sections</code> content, which populates the tool/workflow sections below.
Expand Down Expand Up @@ -110,7 +110,7 @@ <h2 class="accordion-header" id="headingTwo">
<br>
<small>
<code>
http://{{ HOSTNAME }}/lab/export?content_root=https://raw.githubusercontent.com/myusername/myrepo/path/to/content/main.yml
http://{{ HOSTNAME }}/lab/export?content_root=https://raw.githubusercontent.com/myusername/myrepo/path/to/content/base.yml
</code>
</small>
</li>
Expand Down Expand Up @@ -204,7 +204,7 @@ <h5 class="modal-title">Galaxy {{ site_name }}</h5>
$(`#${id}`).append(exportInfoButton);
}
$(document).ready(function() {
addHoverInfo('headerSection', 'main.yml');
addHoverInfo('headerSection', 'base.yml');
addHoverInfo('introSection', 'templates/intro.html');
addHoverInfo('section_1Section', 'section_1.yml');
addHoverInfo('section_2Section', 'section_2.yml');
Expand Down
4 changes: 2 additions & 2 deletions webapp/home/labs/genome/base.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Test this locally with:
# http://127.0.0.1:8000/lab/export?content_root=http://localhost:8000/static/home/labs/genome/main.yml
# http://127.0.0.1:8000/lab/export?content_root=http://localhost:8000/static/home/labs/genome/base.yml

# Request this on site.usegalaxy.org.au with:
# https://site.usegalaxy.org.au/lab/export?content_root=https://site.usegalaxy.org.au/static/home/labs/genome/main.yml
# https://site.usegalaxy.org.au/lab/export?content_root=https://site.usegalaxy.org.au/static/home/labs/genome/base.yml

# Check out the documentation for building exported labs:
# https://site.usegalaxy.org.au/lab/export
Expand Down
1 change: 0 additions & 1 deletion webapp/home/labs/genome/main.yml

This file was deleted.

4 changes: 2 additions & 2 deletions webapp/home/labs/proteomics/base.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Test this locally with:
# http://127.0.0.1:8000/lab/export?content_root=http://localhost:8000/static/home/labs/proteomics/main.yml
# http://127.0.0.1:8000/lab/export?content_root=http://localhost:8000/static/home/labs/proteomics/base.yml

# Request this on site.usegalaxy.org.au with:
# https://site.usegalaxy.org.au/lab/export?content_root=https://site.usegalaxy.org.au/static/home/labs/proteomics/main.yml
# https://site.usegalaxy.org.au/lab/export?content_root=https://site.usegalaxy.org.au/static/home/labs/proteomics/base.yml

# Check out the documentation for building exported labs:
# https://site.usegalaxy.org.au/lab/export
Expand Down
1 change: 0 additions & 1 deletion webapp/home/labs/proteomics/main.yml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Default spec for an exported subsite landing page

# You can test with: /lab/export?content_root=https://raw.githubusercontent.com/usegalaxy-au/galaxy-media-site/dev/webapp/home/labs/docs/main.yml
# You can test with: /lab/export?content_root=https://raw.githubusercontent.com/usegalaxy-au/galaxy-media-site/dev/webapp/home/labs/docs/base.yml

site_name: Archaeology
lab_name: Archaeology Lab
Expand Down
2 changes: 1 addition & 1 deletion webapp/home/tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
'Report statistics from sequencing reads',
'Assemble Nanopore long reads.',
)
TEST_LAB_CONTENT_URL = f'{MOCK_LAB_BASE_URL}/static/home/labs/docs/main.yml'
TEST_LAB_CONTENT_URL = f'{MOCK_LAB_BASE_URL}/static/home/labs/docs/base.yml'
TEST_LAB_URL = f'/lab/export?content_root={TEST_LAB_CONTENT_URL}'


Expand Down
2 changes: 1 addition & 1 deletion webapp/webapp/settings/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
LOG_ROOT = ensure_dir(BASE_DIR / 'webapp/logs')
RECIPIENT_MASTER_CSV = BASE_DIR / '../scripts/mail/recipient_records.csv'
DEFAULT_EXPORTED_LAB_CONTENT_ROOT = (
f'http://{HOSTNAME}/static/home/labs/docs/main.yml'
f'http://{HOSTNAME}/static/home/labs/docs/base.yml'
)

# Hostnames
Expand Down

0 comments on commit fea6678

Please sign in to comment.