diff --git a/gen3/docs/gen3-resources/operator-guide/helm/helm-config/index.md b/gen3/docs/gen3-resources/operator-guide/helm/helm-config/index.md index 963bf67f..8293dfca 100644 --- a/gen3/docs/gen3-resources/operator-guide/helm/helm-config/index.md +++ b/gen3/docs/gen3-resources/operator-guide/helm/helm-config/index.md @@ -203,67 +203,4 @@ This is an option if you want to make HTML versions of Jupyter notebooks viewabl ## Front End (Portal) Configuration examples -You can see more about [generally configuring the portal here](https://github.com/uc-cdis/data-portal/blob/master/docs/portal_config.md). Below, there are different code examples for aspects of the portal. - -### Login Page - -#### Helix Image - -Customize the image that appears on the [Login Page](https://gen3.datacommons.io/login) with a vector graphic (eg. *.svg) of your choice. - -* [Review the code to save the image](https://github.com/uc-cdis/cdis-manifest/blob/456e1a3b5b3cc5dc23b83e1f96c0770a2007162a/gen3.datacommons.io/portal/gitops-sponsors/gene_bgy.svg) -* [Review code to include the path-to-image in gitops.json](https://github.com/uc-cdis/cdis-manifest/blob/456e1a3b5b3cc5dc23b83e1f96c0770a2007162a/gen3.datacommons.io/portal/gitops.json#L130) - -#### Information on Login and Commons - -Customize the text that appears on the [Login Page](https://gen3.datacommons.io/login) by specifying title, description, subtitle, contact, or email. - -* [Review the code to edit title, subtitle, text, contact, and email](https://github.com/uc-cdis/cdis-manifest/blob/456e1a3b5b3cc5dc23b83e1f96c0770a2007162a/gen3.datacommons.io/portal/gitops.json#L124-L129) - -### Landing Page - -#### Information on Commons - -Customize the name of the Data Commons, the info text, and the button below that appear on the top left side of the Landing Page after logging in. - -* [Review the code to edit heading, text, and link](https://github.com/uc-cdis/cdis-manifest/blob/456e1a3b5b3cc5dc23b83e1f96c0770a2007162a/gen3.datacommons.io/portal/gitops.json#L39-L44) - -#### Summary Statistics - -Customize the summary statistics that appear on the top right side of the Landing Page after logging in. The attributes are graphQL fields, which must be in the dictionary, configured in the etlMapping.yaml, and populated with data on the backend. - -* [Review the code to edit graphQL queries](https://github.com/uc-cdis/cdis-manifest/blob/456e1a3b5b3cc5dc23b83e1f96c0770a2007162a/gen3.datacommons.io/portal/gitops.json#L3-L36) -* [Review the code to edit the graphQl queries after being logged in](https://github.com/uc-cdis/cdis-manifest/blob/4a922a04456423fea5d1e59c5431cedb460280d0/data.midrc.org/portal/gitops.json#L98-L113) - -#### Cards - -Customize the cards that appear on the bottom of the Landing Page after logging in. - -* [Review the code to edit name, icons, body, link, and label of the cards](https://github.com/uc-cdis/cdis-manifest/blob/551f0963e60f6000ae8b9987592495406a031c81/gen3.datacommons.io/portal/gitops.json#L84-L134) -* Adding a new icon requires saving the icon in [this repository](https://github.com/uc-cdis/data-portal/tree/master/src/img/icons) and in [this file](https://github.com/uc-cdis/data-portal/blob/67f2b83227b9c3b48143bd2938cad160fc225394/src/img/icons/index.jsx). - -### Data Commons - -#### Title - -Customize the title that appears in the top left corner. - -* [Review the code to edit the title of the Data Commons](https://github.com/uc-cdis/cdis-manifest/blob/a68f8df12173e4b9d06dcdf3fad2cc1643a73f89/gen3.theanvil.io/portal/gitops.json#L71-L72) - -#### Top Bar - -Customize the top bar that appears in the top right corner. - -* [Review the code to edit the top bar (link, name, icon, dropdown) of the Data Commons](https://github.com/uc-cdis/cdis-manifest/blob/4a922a04456423fea5d1e59c5431cedb460280d0/data.midrc.org/portal/gitops.json#L146-L171) - -#### Color Theme - -Customize the color theme for buttons, top navigation bar, and any types of charts on the Exploration and Landing Page - -* [Review the code to edit the 9 colors of a Data Commons](https://github.com/uc-cdis/cdis-manifest/blob/4a922a04456423fea5d1e59c5431cedb460280d0/data.midrc.org/portal/gitops.json#L146-L171) - -#### Footer Logo - -Customize the logos in the Footer. - -* [Review the code to edit the source, link, and name of logos in the footer of a Data Commons](https://github.com/uc-cdis/cdis-manifest/blob/551f0963e60f6000ae8b9987592495406a031c81/gen3.datacommons.io/portal/gitops.json#L156-L168) +There are different code examples for various aspects of the portal in the document [Customize the Front End](../../customize-frontend.md) in the Post-Deployment section. You can see more about [generally configuring the portal here](https://github.com/uc-cdis/data-portal/blob/master/docs/portal_config.md). diff --git a/gen3/docs/gen3-resources/operator-guide/helm/index.md b/gen3/docs/gen3-resources/operator-guide/helm/index.md index 87e90318..f7f55bac 100644 --- a/gen3/docs/gen3-resources/operator-guide/helm/index.md +++ b/gen3/docs/gen3-resources/operator-guide/helm/index.md @@ -1,5 +1,7 @@ # Helm to Configure and Deploy Gen3 +## [**-*Jump to quick-start videos*-**](#getting-started-with-helm-quick-start-videos) + [**Helm**](https://helm.sh) plays a crucial role in simplifying the deployment and management of Gen3 components within your environment. It is a Kubernetes package manager that allows you to define, install, and upgrade even complex applications with ease. If you haven't already installed Helm for your Gen3 deployment: @@ -64,3 +66,36 @@ By centralizing these common features in a dedicated chart, we reduce redundancy - **Isolation**: Each microservice operates independently within its own Helm chart, allowing for isolation and decoupling of services. This isolation enhances fault tolerance and simplifies updates and maintenance. - **Customization**: Microservices can have their specific configurations and dependencies defined within their Helm charts, making it easier to tailor each service to its unique requirements. + +## Getting started with Helm - Quick-Start Videos + +### Deploy with Kind and Helm + +!!! info "Quick-start to deploy Gen3 with Kind & Helm" + + This video walks through basic set up a Gen3 data commons on your laptop using Kind and Gen3 Helm charts. + +

+ +### Deploy with Minikube and Helm + +!!! info "Quick-start to deploy Gen3 with Minikube & Helm" + + This video walks through basic set up a Gen3 data commons on your laptop using Minikube and Gen3 Helm charts. + +

+ +### Additional post-deployment configuration tips + +!!! info "Gen3 Helm Charts: SSL, Permissions, Test Data, Tabs, and more" + + This video covers several aspects of configuration after deploying Gen3, including: + + * How to generate SSL certificates for secure communication + * Updating permissions to ensure seamless access control + * Submitting test data to validate your configurations + * Enabling persistence for data continuity + * Configuring the Workspace Tab for launching notebooks + * Configuring the Exploration Tab for advanced data discovery + +