This repository has been archived by the owner on Jan 8, 2025. It is now read-only.
Move all contributing docs to this repo #434
Merged
Conversation
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
Instructions for contributing to the documentation and docs engine are distributed between the "Contributing" section of the Teleport docs site and the README of this repo. This change makes this repo the single source of truth for docs contribution guidance. Moving all docs contribution guidance into this repo has the following advantages: - It's easier to keep this information up to date. - We can free up a navigation sidebar section on the main docs site while still keeping this information discoverable. Summary of changes: - Move all pages from the `/docs/contributing/documentation` section of the docs site into the `docs-contributors` directory of this repo. This required changing UI components in these pages to be compatible with GitHub Markdown. - Organize `yarn` information into a command reference and move the reference into `docs-contributors`. - Remove README info that overlaps with the UI reference. - Move docs site configuration information from the README into a separeate guide. - Remove instructions for running a dev server with Docker. These have often been a source of confusion for readers, and require the same initial setup as using `yarn`.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Reviewer note: once this is merged, I'll remove the "Contributing" section from the Teleport docs site. |
avatus
approved these changes
Feb 9, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Instructions for contributing to the documentation and docs engine are distributed between the "Contributing" section of the Teleport docs site and the README of this repo. This change makes this repo the single source of truth for docs contribution guidance.
Moving all docs contribution guidance into this repo has the following advantages:
Summary of changes:
/docs/contributing/documentationsection of the docs site into thedocs-contributorsdirectory of this repo. This required changing UI components in these pages to be compatible with GitHub Markdown.yarninformation into a command reference and move the reference intodocs-contributors.yarn.