Merge branch 'main' into google-cloud-python

.github/workflows/test-website.yml

@@ -33,5 +33,8 @@ jobs:
       - name: Lint 🔍
         run: yarn run lint
 
+      - name: Format 🥇
+        run: yarn run format
+
       - name: Build site 🔨
         run: yarn run build

docs/docs/community/decision-making.md → docs/community/decision-making.md

@@ -40,10 +40,9 @@ Learn more in [Gitpod's documentation on decision making][gitpod-rfd].
 
 Minor updates to the codebase and documentation can be discussed in GitHub issues or in pull requests during code review. Contributors are expected to (informally) follow the consent-based decision making philosophy in these discussions.
 
-
 <!-- Reusable links -->
 
-[nebari-team]: /docs/community/team-structure
+[nebari-team]: /community/team-structure
 [core-team]: https://github.com/orgs/nebari-dev/teams/core-team
 [consent-decision-making]: https://www.sociocracyforall.org/consent-decision-making/
 [rfd-issue]: https://github.com/nebari-dev/governance/issues/new?assignees=&labels=type%3A+RFD&projects=&template=RFD.md&title=RFD+-+Title

docs/docs/community/doc-contributions.md → docs/community/doc-contributions.md

@@ -161,7 +161,7 @@ This command starts a local development server and opens up a browser window.
 Most changes are reflected live without having to restart the server.
 
 :::note
-By default, this will load your site at <http://localhost:3000/>.
+By default, this will load your site at \<http://localhost:3000/\>.
 
 You can specify a different port with `yarn start --port <port-number>`.
 :::
@@ -183,7 +183,7 @@ yarn run serve
 ```
 
 :::note
-By default, this will also load your site at <http://localhost:3000/>.
+By default, this will also load your site at \<http://localhost:3000/\>.
 
 You can specify a different port with `yarn start --port <port-number>`.
 :::

docs/docs/community/index.mdx → docs/community/introduction.mdx

@@ -134,9 +134,7 @@ Our contributing and community guidelines take inspiration from the following pr
 - [Julia Language](https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md)
 - [nteract](https://github.com/nteract/nteract/blob/main/CONTRIBUTING.md)
 
-<!-- <DocCardList items={useCurrentSidebarCategory().items} /> -->
-
-<!-- Links -->
+{/*  Links */}
 
 [nebari-issues]: https://github.com/nebari-dev/nebari/issues
 [nebari-prs]: https://github.com/nebari-dev/nebari/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc
@@ -145,7 +143,7 @@ Our contributing and community guidelines take inspiration from the following pr
 [nebari-design]: https://github.com/nebari-dev/nebari-design
 [nebari-governance]: https://github.com/nebari-dev/governance
 
-<!-- Internal links -->
+{/* Internal links  */}
 
 [code-contributions]: community/code-contributions.mdx
 [docs-contributions]: community/doc-contributions.md

docs/docs/community/issues.md → docs/community/issues.md

@@ -47,7 +47,7 @@ If an issue is affecting you, start at the top of this list and complete as many
 
 1. Check the [issue tracker][nebari-issues], if there is an open issue for this same problem, add a reaction or more details to the issue
    to indicate that it’s affecting you (tip: make sure to also check the open [pull requests][nebari-prs] for ongoing work).
-2. You should also check the [troubleshooting guide](../troubleshooting.mdx) in these docs to see if your problem is already listed there.
+2. You should also check the [troubleshooting guide][troubleshooting] in these docs to see if your problem is already listed there.
 3. If there is an open issue, and you can add more detail, write a comment describing how the problem is affecting you,
    OR if you can, write up a work-around or improvement for the issue.
 4. If there is not an issue, write the most complete description of what’s happening including reproduction steps.
@@ -66,7 +66,11 @@ The following actions are typically useful:
 - Linking to related issues or discussions while briefly describing how they are related, for instance “See also #xyz for a similar attempt at this” or “See also #xyz where the same thing happened in another cloud provider" provides context and helps the discussion.
 - Summarizing long discussions on issues to help new and existing contributors quickly understand the background, current status, and course of action for the issue.
 
-<!-- links -->
+<!-- Internal links -->
+
+[troubleshooting]: /docs/troubleshooting
+
+<!-- External Links -->
 
 [nebari-issues]: https://github.com/nebari-dev/nebari/issues
 [nebari-labels]: https://github.com/nebari-dev/nebari/labels

docs/docs/community/maintainers/triage-guidelines.md → docs/community/maintainers/triage-guidelines.md

@@ -129,5 +129,5 @@ Support requests should be directed to the following channels:
 
 [code-contributions]: community/code-contributions.mdx
 [github-conventions]: community/maintainers/github-conventions.md
-[troubleshooting]: ../../troubleshooting.mdx
-[saved-replies]: ./saved-replies.md
+[troubleshooting]: /docs/troubleshooting
+[saved-replies]: community/maintainers/saved-replies.md

docs/docs/community/nebari-tests.md → docs/community/nebari-tests.md

@@ -11,7 +11,7 @@ This page has some tips for testing your contributions to make sure it works as
 
 ### Test CLI manually
 
-If you have an [editable installation of Nebari](code-contributions#install-nebari-in-editable-mode), you can test your changes by running the [Nebari CLI commands](../get-started/quickstart) from within your development environment.
+If you have an [editable installation of Nebari](code-contributions#install-nebari-in-editable-mode), you can test your changes by running the [Nebari CLI commands][quickstart] from within your development environment.
 For example, you can run `nebari init` and make sure it builds the `nebari-config.yaml` file without errors.
 
 ### Test CLI with `pytest`
@@ -45,7 +45,7 @@ After you make changes, you can re-deploy your Nebari instance to test it manual
 
 ### Testing the deployment with `pytest`
 
-The deployment and integration tests help us test various features of a [local Nebari deployment on Kind](#testing-the-nebari-deployment-terraform),
+The deployment and integration tests help us test various features of a [local Nebari deployment on Kind](/docs/how-tos/nebari-local),
 such as Dask Gateway, external integrations, state of the Kubernetes cluster, and more.
 Before you can run these tests, you need to create a test user on your deployment, for example with:
 
@@ -80,7 +80,7 @@ It can help you review and resolve day-to-day issues in the deployed clusters qu
 
 You can install `k9s` on macOS, Windows, and Linux with [these instructions project's README](https://github.com/derailed/k9s).
 
-For more details on using `k9s`, check out the [documentation on debugging Nebari](../how-tos/debug-nebari#debugging-the-kubernetes-cluster-using-k9s).
+For more details on using `k9s`, check out the [documentation on debugging Nebari][debugging-nebari].
 
 ### Cloud testing
 
@@ -233,3 +233,8 @@ To get around this, set the `NEBARI_K8S_VERSION` environment variable with:
 ```bash
 export NEBARI_K8S_VERSION=1.20
 ```
+
+<!-- Internal links -->
+
+[quickstart]: /docs/get-started/quickstart
+[debugging-nebari]: /docs/how-tos/debug-nebari#debugging-the-kubernetes-cluster-using-k9s

docs/community/plugins.md

@@ -0,0 +1,17 @@
+---
+id: plugins
+title: Plugins (Extensions)
+description: List of Nebari plugins
+---
+
+Nebari plugins (sometimes referred to as extensions) allow developers to add new features relatively easily without the need to modify the core Nebari code base. At the moment, there are two types of plugins `stages` and `subcommands`. Stage plugins allow users to deploy new features alongside the existing the Nebari features whereas subcommand plugins allow users to extend or modify the existing Nebari CLI.
+
+You can learn to use and create Nebari extensions in the [extension mechanism documentation](/docs/how-tos/nebari-extension-system).
+
+## Verified community extensions
+
+The following community-developed extensions are recognized and verified by the Nebari development team.
+
+- The **[ML Flow extension for AWS](https://github.com/MetroStar/nebari-mlflow-aws)** is designed to integrate [MLFlow](https://mlflow.org/) into Nebari deployments utilizing AWS (Amazon Web Services) as the provider. It provides a robust, collaborative environment for AI/ML professionals to manage experiments, track metrics, and deploy models.
+- The **[Label Studio](https://github.com/MetroStar/nebari-label-studio)** integrates [Label Studio](https://labelstud.io/) into the Nebari platform, allowing seamless labeling functionality within Nebari. Utilizing Python, Terraform, Kubernetes, and Helm charts, the plugin provides a configurable deployment and authentication through Keycloak.
+- The **[Self Registration](https://github.com/nebari-dev/nebari-self-registration)** extension allows potential new users of a Nebari deployment to self-register through a coupon code. A new self-registration page is generated on the Nebari server where users can input their information and a coupon code. Once the form is validated, the new user will be auto-generated on the Nebari deployment. It can also be configured to give new users a set expiration date.

docs/docs/community/style-guide.md → docs/community/style-guide.md

@@ -30,7 +30,7 @@ Follow your best judgment, and feel free to add to this document following our c
 - **Avoid abbreviations** like "e.g.", "i.e.", and "etc.". Use full words like "for example", "that is", and "and so on" respectively.
 - Use **serial commas**, also known as Oxford comma. For example: "Nebari brand uses purple, yellow, and green."
 - Leave **only one blank space between sentences**.
-- **Break up long lines in code snippets** with "`\`" for better readability. For example, see the code block in [Automatic DNS provision](../how-tos/domain-registry#automatic-dns-provision).
+- **Break up long lines in code snippets** with "`\`" for better readability. For example, see the code block in [Automatic DNS provision][automatic-dns-provision].
 - Try and **use [semantic line breaks](https://sembr.org/)** to help with documentation and contribution reviews.
 - **Prefer American English** over British or other English variant to keep spelling consistency.
 
@@ -99,3 +99,7 @@ For example: "To start JupyterLab, you run `jupyter lab`."
 - The [Microsoft Writing Style Guide](https://learn.microsoft.com/en-gb/style-guide/welcome/) is also a very thorough style guide. The included A-Z word list is a handy reference if you're unsure about a specific term.
 - [Digital Ocean's tutorial style guide](https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines).
 - [Write the Docs collection of resources for accessible writing](https://www.writethedocs.org/guide/writing/accessibility/).
+
+<!-- Internal links -->
+
+[automatic-dns-provision]: /docs/how-tos/domain-registry#automatic-dns-provision

docs/docs/community/team-structure.md → docs/community/team-structure.md

@@ -57,9 +57,9 @@ Nebari follows a nomination process to add new team members[^2], as detailed in
 
 [^2]: All except the [Emeritus core](#emeritus-core) team are decided through nominations.
 
-| Team        | Requirements for nomination                                                                                         | Nominators                                                          | Approvers                                                                                                               |
-| ----------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
-| Triage      | Engage with (create or comment on) one or more issue/PR/discussion in [`nebari-dev`](https://github.com/nebari-dev) | Any community member (including self)                                        | Any Core team member                                                                                                    |
-| Contributor | Two or more [contributions](./#how-to-contribute) to Nebari with intention to continue contributing regularly                                          | Any community member (including self)                                    | Any Core team member                                                                                |
-| Core        | [Contributors team](#contributors) member with a record of regular, valuable, and high-quality contributions to Nebari for at least one month  | Any community member (including self) and one Core team member | Core team makes a [consent-based decision](https://www.sociocracyforall.org/consent-decision-making/) |
-| Conduct     | Member of the Contributor or Core Team with adequate training to handle CoC reports         | Any community member (including self)                                    | Core team makes a [consent-based decision](https://www.sociocracyforall.org/consent-decision-making/)                                                                                 |
+| Team        | Requirements for nomination                                                                                                                   | Nominators                                                     | Approvers                                                                                             |
+| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
+| Triage      | Engage with (create or comment on) one or more issue/PR/discussion in [`nebari-dev`](https://github.com/nebari-dev)                           | Any community member (including self)                          | Any Core team member                                                                                  |
+| Contributor | Two or more [contributions](/community/introduction/#how-to-contribute) to Nebari with intention to continue contributing regularly           | Any community member (including self)                          | Any Core team member                                                                                  |
+| Core        | [Contributors team](#contributors) member with a record of regular, valuable, and high-quality contributions to Nebari for at least one month | Any community member (including self) and one Core team member | Core team makes a [consent-based decision](https://www.sociocracyforall.org/consent-decision-making/) |
+| Conduct     | Member of the Contributor or Core Team with adequate training to handle CoC reports                                                           | Any community member (including self)                          | Core team makes a [consent-based decision](https://www.sociocracyforall.org/consent-decision-making/) |