-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Additional user guide updates #283
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,9 @@ | ||
| authors: | ||
| qureshi: | ||
| name: Jawad Qureshi | ||
| description: Lead Platform Engineer | ||
| description: Lead Platform Engineer, CTDS | ||
| avatar: https://github.com/jawadqur.png | ||
| elise: | ||
| name: Elise Castle | ||
| description: Platform Engineer - Gen3 | ||
| url: https://github.com/EliseCastle23 | ||
| description: Platform Engineer, CTDS | ||
| avatar: https://github.com/EliseCastle23.png | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ date: 2023-09-13 | |
| slug: Gen3 on laptop | ||
| categories: | ||
| - Operator | ||
| - CTDS | ||
| tags: | ||
| - Kubernetes | ||
| - Minikube | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ authors: | |
| date: 2023-08-13 | ||
| categories: | ||
| - Operator | ||
| - CTDS | ||
| slug: k8s for development | ||
| tags: | ||
| - Kubernetes | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ date: 2023-10-13 | |
| slug: k8s tools | ||
| categories: | ||
| - Operator | ||
| - CTDS | ||
| tags: | ||
| - Kubernetes | ||
| - Minikube | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| <!-- | ||
| Copyright (c) 2016-2024 Martin Donath <[email protected]> | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to | ||
| deal in the Software without restriction, including without limitation the | ||
| rights to use, copy, modify, merge, publish, distribute, sublicense, and/or | ||
| sell copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in | ||
| all copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS | ||
| IN THE SOFTWARE. | ||
| --> | ||
|
|
||
| <!-- Footer --> | ||
| <footer class="md-footer"> | ||
|
|
||
| <!-- Link to previous and/or next page --> | ||
| {% if "navigation.footer" in features %} | ||
| {% if page.previous_page or page.next_page %} | ||
| {% if page.meta and page.meta.hide %} | ||
| {% set hidden = "hidden" if "footer" in page.meta.hide %} | ||
| {% endif %} | ||
| <nav | ||
| class="md-footer__inner md-grid" | ||
| aria-label="{{ lang.t('footer') }}" | ||
| {{ hidden }} | ||
| > | ||
|
|
||
| <!-- Link to previous page --> | ||
| {% if page.previous_page %} | ||
| {% set direction = lang.t("footer.previous") %} | ||
| <a | ||
| href="{{ page.previous_page.url | url }}" | ||
| class="md-footer__link md-footer__link--prev" | ||
| aria-label="{{ direction }}: {{ page.previous_page.title | e }}" | ||
| > | ||
| <div class="md-footer__button md-icon"> | ||
| {% set icon = config.theme.icon.previous or "material/arrow-left" %} | ||
| {% include ".icons/" ~ icon ~ ".svg" %} | ||
| </div> | ||
| <div class="md-footer__title"> | ||
| <span class="md-footer__direction"> | ||
| {{ direction }} | ||
| </span> | ||
| <div class="md-ellipsis"> | ||
| {{ page.previous_page.title }} | ||
| </div> | ||
| </div> | ||
| </a> | ||
| {% endif %} | ||
|
|
||
| <!-- Link to next page --> | ||
| {% if page.next_page %} | ||
| {% set direction = lang.t("footer.next") %} | ||
| <a | ||
| href="{{ page.next_page.url | url }}" | ||
| class="md-footer__link md-footer__link--next" | ||
| aria-label="{{ direction }}: {{ page.next_page.title | e }}" | ||
| > | ||
| <div class="md-footer__title"> | ||
| <span class="md-footer__direction"> | ||
| {{ direction }} | ||
| </span> | ||
| <div class="md-ellipsis"> | ||
| {{ page.next_page.title }} | ||
| </div> | ||
| </div> | ||
| <div class="md-footer__button md-icon"> | ||
| {% set icon = config.theme.icon.next or "material/arrow-right" %} | ||
| {% include ".icons/" ~ icon ~ ".svg" %} | ||
| </div> | ||
| </a> | ||
| {% endif %} | ||
| </nav> | ||
| {% endif %} | ||
| {% endif %} | ||
|
|
||
| <!-- Further information --> | ||
| <div class="md-footer-meta md-typeset"> | ||
| <div class="md-footer-meta__inner md-grid"> | ||
| {% include "partials/copyright.html" %} | ||
|
|
||
| <!-- Custom link to Center for Translational Data Science --> | ||
| <div class="md-footer__link" style="vertical-align: middle; padding-bottom: 10px;"> | ||
| <a href="https://ctds.uchicago.edu/" target="_blank" rel="noopener noreferrer"> | ||
| Center for Translational Data Science | ||
| </a> | ||
| </div> | ||
| <!-- End of custom link --> | ||
|
|
||
| <!-- Social links --> | ||
| {% if config.extra.social %} | ||
| {% include "partials/social.html" %} | ||
| {% endif %} | ||
| </div> | ||
| </div> | ||
| </footer> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| {#- | ||
| This file was automatically generated - do not edit | ||
| -#} | ||
| {% set class = "md-header" %} | ||
| {% if "navigation.tabs.sticky" in features %} | ||
| {% set class = class ~ " md-header--shadow md-header--lifted" %} | ||
| {% elif "navigation.tabs" not in features %} | ||
| {% set class = class ~ " md-header--shadow" %} | ||
| {% endif %} | ||
| <header class="{{ class }}" data-md-component="header"> | ||
| <nav class="md-header__inner md-grid" aria-label="{{ lang.t('header') }}"> | ||
| <a href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" title="{{ config.site_name | e }}" class="md-header__button md-logo" aria-label="{{ config.site_name }}" data-md-component="logo"> | ||
| {% include "partials/logo.html" %} | ||
| </a> | ||
| <label class="md-header__button md-icon" for="__drawer"> | ||
| {% set icon = config.theme.icon.menu or "material/menu" %} | ||
| {% include ".icons/" ~ icon ~ ".svg" %} | ||
| </label> | ||
| <div class="md-header__title" data-md-component="header-title"> | ||
| <div class="md-header__ellipsis"> | ||
| <div class="md-header__topic"> | ||
| <span class="md-ellipsis"> | ||
| {{ config.site_name }} | ||
| </span> | ||
| </div> | ||
| <div class="md-header__topic" data-md-component="header-topic"> | ||
| <span class="md-ellipsis"> | ||
| {% if page.meta and page.meta.title %} | ||
| {{ page.meta.title }} | ||
| {% else %} | ||
| {{ page.title }} | ||
| {% endif %} | ||
| </span> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| {% if config.theme.palette %} | ||
| {% if not config.theme.palette is mapping %} | ||
| {% include "partials/palette.html" %} | ||
| {% endif %} | ||
| {% endif %} | ||
| {% if not config.theme.palette is mapping %} | ||
| {% include "partials/javascripts/palette.html" %} | ||
| {% endif %} | ||
| {% if config.extra.alternate %} | ||
| {% include "partials/alternate.html" %} | ||
| {% endif %} | ||
|
|
||
| <!-- Custom link to Gen3.org (with an external link icon) --> | ||
| <div style="margin-right: 10px; display: flex; align-items: center;"> | ||
| <h1 href="https://gen3.org/" class="md-header__button" aria-label="Gen3.org" target="_blank" rel="noopener noreferrer" style="display: flex; align-items: center;"> | ||
| Gen3.org | ||
| <!-- Insert your preferred external link icon here --> | ||
| <svg xmlns="http://www.w3.org/2000/svg" width="1em" height="1em" style="margin-left: 5px;" viewBox="0 0 16 16"><g fill="currentColor" fill-rule="evenodd"><path d="M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5"/><path d="M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0z"/></g></svg> | ||
| </h1> | ||
| </div> | ||
| <!-- End of custom link to Gen3.org with an external link icon --> | ||
|
|
||
|
|
||
| {% if "material/search" in config.plugins %} | ||
| <label class="md-header__button md-icon" for="__search"> | ||
| {% set icon = config.theme.icon.search or "material/magnify" %} | ||
| {% include ".icons/" ~ icon ~ ".svg" %} | ||
| </label> | ||
| {% include "partials/search.html" %} | ||
| {% endif %} | ||
| {% if config.repo_url %} | ||
| <div class="md-header__source"> | ||
| {% include "partials/source.html" %} | ||
| </div> | ||
| {% endif %} | ||
| </nav> | ||
| {% if "navigation.tabs.sticky" in features %} | ||
| {% if "navigation.tabs" in features %} | ||
| {% include "partials/tabs.html" %} | ||
| {% endif %} | ||
| {% endif %} | ||
| </header> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am curious why you are changing this from Gen3 to CTDS. Since this is all Gen3 documentation, and since I think the users will be more familiar with Gen3 than with CTDS (especially since we are inconsistent about CTDS vs CDIS) -- it feels like it would be better to use Gen3 . We can discuss more -- doesn't need to hold up merging this PR.