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.

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

Update permalinks.md #289

Open
wants to merge 1 commit into
base: main
from
Open

Update permalinks.md #289

wants to merge 1 commit into from

Conversation

@casals
Copy link
Contributor

@casals casals commented Oct 8, 2020

Why:

There's a linked reference to this page CONTRIBUTING.md, which makes it a first stop when content contributors are looking for information about permalinks. While the current version of the page is technically accurate, it may be confusing especially for first-time contributors: failing to properly reference an internal link generates a "permalink" lint error during the PR automated testing. As a first-time contributor, it took me a couple of trials/patches to my original PR to get it right.

I didn't open an issue related to this situation, but I thought it'd be useful to add extra information about it for content contributors.

What's being changed:

Added a paragraph at the end of the document explaining how internal links should be referenced (and why).

Check off the following:

Included contributor-friendly information about permalinks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

1 participant
You can’t perform that action at this time.