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

Jump to bottom

Add instructions for changing deeplinks when editing headings #19186

Merged
merged 3 commits into from
Nov 11, 2019
Merged

Add instructions for changing deeplinks when editing headings #19186

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea90177
add note about changing deeplinks when editing headings
Oct 31, 2019
731b94f
Update docs/contributing/docs-contributions.md
laurieontech Nov 6, 2019
15c9ae0
Update docs/contributing/docs-contributions.md
laurieontech Nov 6, 2019
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
7 changes: 7 additions & 0 deletions docs/contributing/docs-contributions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,13 @@ After going through the [development setup instructions](/contributing/setting-u
- View the changes in your browser at `http://localhost:8000`.
- Commit your changes and [submit a pull request](/contributing/how-to-open-a-pull-request/)!

## Changing headers

It can be necessary to change a heading within the docs. It's important to note that headers automatically generate links with a corresponding URL that can be deeplinked from elsewhere on the site. When changing a header be sure to point all corresponding links to the new URL.
laurieontech marked this conversation as resolved.
Show resolved Hide resolved

- Determine the URL you're looking for. `Changing headers` is linked with a URL ending in `changing-headers`, `Docs renaming instructions` becomes `docs-renaming-instructions`, etc.
- - Update all instances of the old URL to your new one. [Find and replace](https://code.visualstudio.com/docs/editor/codebasics#_search-across-files) in VS Code can help. Check that the context of the original link reference still makes sense with the new one.
laurieontech marked this conversation as resolved.
Show resolved Hide resolved

## Docs renaming instructions

Sometimes it makes sense to move or rename a file as part of docs restructuring or for content clarification. While we recommend keeping URLs consistent as often as possible, here are some tips to minimize errors and keep the docs in a good state:
Expand Down