Skip to content

Commit

Permalink
Update tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelfitzo committed Nov 14, 2024
1 parent 1c600f2 commit 6ee1afc
Show file tree
Hide file tree
Showing 11 changed files with 21 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -176,5 +176,5 @@ Once the client is created, share the client_id and client_secret with the appli

See the following tutorials for additional information relevant to AuthN/AuthZ.

* [Fence Usersync CronJob](../fence_usersync_job.md)
* [AWS IAM Global User](../global_IAM_helm_user.md)
* [Fence Usersync CronJob](/gen3-resources/operator-guide/tutorial_fence_usersync_job/)
* [AWS IAM Global User](/gen3-resources/operator-guide/tutorial_global_IAM_helm_user/)
16 changes: 9 additions & 7 deletions gen3/docs/gen3-resources/operator-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This is the guide for users who want to stand up a new Gen3 instance. It include

* [An **overview of Gen3 deployment** and considerations][deploy overview]
* A [list of prerequisite software and resources][prerequisites] for production deployment of Gen3
* A description of predeployment tasks, including [our approach to **Infrastructure as Code**][infrastructure as code], [preparing an SSL certificate], and [setting up a Secrets manager].
* A description of predeployment tasks, including [our approach to **Infrastructure as Code**][infrastructure as code], [preparing an SSL certificate][ssl], and [setting up a Secrets manager][secrets].
* A [description of the **different authentication methods**][authentication methods] that can be used in Gen3
* [A **guide to Helm deployment and configuration**][helm guide]
* Postdeployment tasks, including [**creating a Data Dictionary** and Data Model][data dictionary], [**submitting data**][submit data], [**customizing search for Query, Exploration, and Discovery pages** in Gen3][customize search], and [**customizing the front end**][customize frontend]
Expand Down Expand Up @@ -55,11 +55,13 @@ Compose-services was used to deploy Gen3 at a small scale, for experimental comm
[helm guide]: /gen3-resources/operator-guide/helm/
[deploy overview]: deploy-gen3.md
[prerequisites]: prerequisites.md
[infrastructure as code]: /gen3-resources/operator-guide/ioc-overview.md
[infrastructure as code]: /gen3-resources/operator-guide/iac-overview/
[ssl]: /gen3-resources/operator-guide/ssl-cert.md
[secrets]: /gen3-resources/operator-guide/secrets-mgr.md
[authentication methods]: /gen3-resources/operator-guide/gen3-authn-methods.md
[data dictionary]: /gen3-resources/operator-guide/create-data-dictionary.md
[submit data]: /gen3-resources/operator-guide/submit-data.md
[customize search]: /gen3-resources/operator-guide/customize-search.md
[customize frontend]: /gen3-resources/operator-guide/customize-frontend.md
[authentication methods]: /gen3-resources/operator-guide/gen3-authn-methods/
[data dictionary]: /gen3-resources/operator-guide/create-data-dictionary/
[submit data]: /gen3-resources/operator-guide/submit-structured-data/
[customize search]: /gen3-resources/operator-guide/customize-search/
[customize frontend]: /gen3-resources/operator-guide/customize-frontend/
[ssl]: /gen3-resources/operator-guide/ssl-cert/
[secrets]: /gen3-resources/operator-guide/tutorial_secrets-mgr/
14 changes: 7 additions & 7 deletions gen3/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,13 @@ nav:
# info from the current operator guide about configuring ETL and data explorer
- Customize the Front End: gen3-resources/operator-guide/customize-frontend.md
- Tutorials:
- AWS IAM Global User: gen3-resources/operator-guide/tutorials/global_IAM_helm_user.md
- Fence Usersync Cronjob: gen3-resources/operator-guide/tutorials/fence_usersync_job.md
- Grafana Alloy Helm Chart: gen3-resources/operator-guide/tutorials/alloy.md
- Grafana Alloy and Faro: gen3-resources/operator-guide/tutorials/faro.md
- Production Deployment: gen3-resources/operator-guide/tutorials/production-setup.md
- Observability: gen3-resources/operator-guide/tutorials/observability.md
- Secrets Manager: gen3-resources/operator-guide/tutorials/secrets-mgr.md
- AWS IAM Global User: gen3-resources/operator-guide/tutorial_global_IAM_helm_user.md
- Fence Usersync Cronjob: gen3-resources/operator-guide/tutorial_fence_usersync_job.md
- Grafana Alloy Helm Chart: gen3-resources/operator-guide/tutorial_alloy.md
- Grafana Alloy and Faro: gen3-resources/operator-guide/tutorial_faro.md
- Production Deployment: gen3-resources/operator-guide/tutorial_production-setup.md
- Observability: gen3-resources/operator-guide/tutorial_observability.md
- Secrets Manager: gen3-resources/operator-guide/tutorial_secrets-mgr.md
- Gen3 Developer Guide - Extend Gen3:
- gen3-resources/developer-guide/index.md
- Gen3 Architecture: gen3-resources/developer-guide/architecture-new.md
Expand Down
6 changes: 3 additions & 3 deletions gen3/overrides/partials/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@

<!-- 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;">
<a href="https://gen3.org/" class="md-header__button" aria-label="Gen3.org" target="_blank" rel="noopener noreferrer" style="display: flex; align-items: center; font-size: 1.6em; font-weight: bold;">
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>
<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 16h10a.5.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>
</a>
</div>
<!-- End of custom link to Gen3.org with an external link icon -->

Expand Down

0 comments on commit 6ee1afc

Please sign in to comment.