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

Jump to bottom

Update documents #1739

Merged
merged 2 commits into from Jun 17, 2022
Merged

Update documents #1739

merged 2 commits into from Jun 17, 2022

Conversation

PeterDaveHello
Copy link
Member

@PeterDaveHello PeterDaveHello commented Jun 16, 2022

Description

Update dated/redirected links in CONTRIBUTION.md, and improve the format in README.md.

Motivation and Context

Just make the documents better

Testing Details

No test needed.

Types of changes

  • Documentation
  • Version change (Update, remove or add more Node.js versions)
  • Variant change (Update, remove or add more variants, or versions of variants)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Others (non of above)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING.md document.
  • All new and existing tests passed.

@PeterDaveHello
docs: Update GitHub links in CONTRIBUTING.md
d76a0ed 
Those links in the doc are now all 301 redirected to somewhere else,
should better update them before it's dead.
@PeterDaveHello
docs: Improve markdown format in README.md
07c284e 
There should be a blank line after the headings
@PeterDaveHello PeterDaveHello requested a review from a team Jun 16, 2022
@SimenB
Copy link
Member

SimenB commented Jun 16, 2022

linter is unhappy

@PeterDaveHello
Copy link
Member Author

PeterDaveHello commented Jun 16, 2022

linter is unhappy

That's kind of bug here: tcort/markdown-link-check#201

I can send another PR to use a workaround fix it, after this one is merged, because, currently, the workaround mentioned here: tcort/markdown-link-check#201 doesn't work on redirected links 😅

@PeterDaveHello PeterDaveHello merged commit 84755fd into nodejs:main Jun 17, 2022
2 of 3 checks passed
@PeterDaveHello PeterDaveHello deleted the update-docs branch Jun 17, 2022
@PeterDaveHello
Copy link
Member Author

PeterDaveHello commented Jun 17, 2022

Well, I was wrong about the workaround, anyway it'll help, for future modifications on the docs, I'll send the PR for it.

PeterDaveHello added a commit to PeterDaveHello/docker-node that referenced this issue Jun 20, 2022
@PeterDaveHello
Add markdown-link-check GitHub Docs workaround, cc nodejs#1739
ea0141c 
Reference:
- tcort/markdown-link-check#201
@PeterDaveHello
Copy link
Member Author

PeterDaveHello commented Jun 20, 2022

PR #1742 sent for the linter unhappy issue 😄

PeterDaveHello added a commit to PeterDaveHello/docker-node that referenced this issue Jun 21, 2022
@PeterDaveHello
Add markdown-link-check GitHub Docs workaround, cc nodejs#1739
583afee 
Reference:
- tcort/markdown-link-check#201
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nschonni nschonni

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@PeterDaveHello @SimenB @nschonni