Skip to content
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.

Sign up for GitHub

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

Backport #11626 to branch/v9 #11638

Merged
merged 1 commit into from
Apr 1, 2022
Merged

Backport #11626 to branch/v9 #11638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/pages/contributing/documentation/how-to-contribute.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ description: Follow this guide to get started contributing changes to Teleport's
This guide describes the general workflow for making documentation changes

## Step 1/4 Set up your local environment
Clone the `gravitational/next` repository via `git clone`:
Clone the `gravitational/docs` repository via `git clone`:

```code
$ git clone https://github.com/gravitational/next
$ git clone https://github.com/gravitational/docs
```

Different versions of the documentation are organized into the `content` directory of `gravitational/next`. Each subdirectory of `content` includes a git submodule for a different branch of `gravitational/teleport`.
Different versions of the documentation are organized into the `content` directory of `gravitational/docs`. Each subdirectory of `content` includes a git submodule for a different branch of `gravitational/teleport`.

Navigate to the root of your local clone of the `gravitational/next` repository and run the following command to populate the `content` directory:
Navigate to the root of your local clone of the `gravitational/docs` repository and run the following command to populate the `content` directory:

```code
$ git submodule update --init --recursive
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/contributing/documentation/issues.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ You can help us estimate the time it will take to plan or review a change by add
|:---|:---|
|docs-new|Requires creating a new docs page|
|docs-edit|Requires editing an existing docs page (perhaps substantially)|
|docs-plumbing|Changes to how we build, display, and deploy the docs—may involve [gravitational/next](https://github.com/gravitational/next)|
|docs-plumbing|Changes to how we build, display, and deploy the docs—may involve [gravitational/docs](https://github.com/gravitational/docs)|
|docs-minor-tweak|Straightforward change to a single paragraph or code snippet|
|docs-assess-scope|Need to assess the scope of the project before starting work|