forked from vercel/next.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Next Docs] Update Git Workflow (vercel#50579)
Update our git workflow in preparation for open-sourcing the content of the docs ([linear task](https://linear.app/vercel/issue/DX-1579/set-up-github-workflow)). **Templates:** - [x] Update docs issue template to encourage contributions - [x] Update PR template to include link to new contribution guide **Code Owners / Reviewers:** - vercel#50841 **Labels:** - [x] Add DevEx team to labeler.json so PRs get the "created by: DevEx team" **Other:** - [x] Remove docs manifest from CI checks as we no longer have one (keep the manifest for errors as they live under `/pages`) - [x] Add `unifiedjs.vscode-mdx` to the vscode extension list
- Loading branch information
1 parent
22ea7d9
commit f6ff2ef
Showing
6 changed files
with
52 additions
and
73 deletions.
There are no files selected for viewing
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,3 @@ | ||
# Updating Documentation Paths | ||
# Contributing to Documentation | ||
|
||
Our documentation currently leverages a [manifest file](/docs/manifest.json), which is how documentation entries are checked. | ||
|
||
When adding a new entry under an existing category you only need to add an entry with `{title: '', path: '/docs/path/to/file.md'}`. The "title" is what is shown on the sidebar. | ||
|
||
When moving the location/url of an entry, the "title" field can be removed from the existing entry and the ".md" extension removed from the "path", then a "redirect" field with the shape of `{permanent: true/false, destination: '/some-url'}` can be added. A new entry should be added with the "title" and "path" fields if the document is renamed within the [`docs` folder](/docs) that points to the new location in the folder, e.g. `/docs/some-url.md` | ||
|
||
Example of moving documentation file: | ||
|
||
Before: | ||
|
||
```json | ||
[ | ||
{ | ||
"path": "/docs/original.md", | ||
"title": "Hello world" | ||
} | ||
] | ||
``` | ||
|
||
After: | ||
|
||
```json | ||
[ | ||
{ | ||
"path": "/docs/original", | ||
"redirect": { | ||
"permanent": false, | ||
"destination": "/new" | ||
} | ||
}, | ||
{ | ||
"path": "/docs/new.md", | ||
"title": "Hello world" | ||
} | ||
] | ||
``` | ||
|
||
> **Note**: The manifest is checked automatically in the "lint" step in CI when opening a PR. | ||
See the [Docs Contribution Guide](https://nextjs.org/docs/community/contribution-guide) to learn how to contribute to the Next.js Documentation. |
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