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

doc: improve doc/markdown file organization coherence #31792

Closed
wants to merge 10 commits into from

Conversation

DavenportEmma
Copy link
Contributor

@DavenportEmma DavenportEmma commented Feb 14, 2020

Improve markdown and documentation file organization.

Fixes: #31741

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added the lib / src Issues and PRs related to general changes in the lib or src directory. label Feb 14, 2020
README.md Outdated Show resolved Hide resolved
@sam-github
Copy link
Contributor

What happened to #31771 ? In the futre, please don't create duplicate PRs, its confusing, and loses the conversation history.

Copy link
Contributor

@sam-github sam-github left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple small suggestions. Please do not close this branch or the PR. Make any changes you need to locally, and force push the branch to update the PR. Thanks!

benchmark/README.md Outdated Show resolved Hide resolved
doc/guides/contributing/pull-requests.md Outdated Show resolved Hide resolved
@jasnell
Copy link
Member

jasnell commented Feb 14, 2020

What happened to #31771 ? In the futre, please don't create duplicate PRs, its confusing, and loses the conversation history.

@sam-github ... yeah, @conordavenport is still getting the hang of git ;-) ... we'll get him sorted on that soon!

GOVERNANCE.md Outdated Show resolved Hide resolved
DavenportEmma and others added 10 commits February 27, 2020 16:29
Updated cpp style guide file name and location and fixed links to
this file.

Fixes: nodejs#31741
Updated collaborator guide file name and location and fixed links
to this file.

Fixes: nodejs#31741
Updated documentation style guide file name and location and updated
links referencing the file.

Fixes: nodejs#31741
Fixed the links referencing markdown files that have moved location

Fixes: nodejs#31741
Moved files to appropriate location and updated naming style for
some of them.

Fixes: nodejs#31741
Reduced line length for linter
Co-Authored-By: James M Snell <jasnell@gmail.com>
@sam-github
Copy link
Contributor

Thanks @conordavenport , I kicked off a ci-lite, then it should be landable.

@sam-github
Copy link
Contributor

@addaleax
Copy link
Member

addaleax commented Mar 4, 2020

Landed in bf7409e

@addaleax addaleax closed this Mar 4, 2020
addaleax pushed a commit that referenced this pull request Mar 4, 2020
* Updated cpp style guide file name and location and fixed links to
  this file.

* Updated collaborator guide file name and location and fixed links
  to this file.

* Updated documentation style guide file name and location and updated
  links referencing the file.

* Moved files to appropriate location and updated naming style for
  some of them.

Fixes: #31741

PR-URL: #31792
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 4, 2020
* Updated cpp style guide file name and location and fixed links to
  this file.

* Updated collaborator guide file name and location and fixed links
  to this file.

* Updated documentation style guide file name and location and updated
  links referencing the file.

* Moved files to appropriate location and updated naming style for
  some of them.

Fixes: #31741

PR-URL: #31792
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Mar 4, 2020
codebytere pushed a commit that referenced this pull request Mar 16, 2020
* Updated cpp style guide file name and location and fixed links to
  this file.

* Updated collaborator guide file name and location and fixed links
  to this file.

* Updated documentation style guide file name and location and updated
  links referencing the file.

* Moved files to appropriate location and updated naming style for
  some of them.

Fixes: #31741

PR-URL: #31792
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
codebytere pushed a commit that referenced this pull request Mar 17, 2020
* Updated cpp style guide file name and location and fixed links to
  this file.

* Updated collaborator guide file name and location and fixed links
  to this file.

* Updated documentation style guide file name and location and updated
  links referencing the file.

* Moved files to appropriate location and updated naming style for
  some of them.

Fixes: #31741

PR-URL: #31792
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
@codebytere codebytere mentioned this pull request Mar 17, 2020
codebytere pushed a commit that referenced this pull request Mar 23, 2020
* Updated cpp style guide file name and location and fixed links to
  this file.

* Updated collaborator guide file name and location and fixed links
  to this file.

* Updated documentation style guide file name and location and updated
  links referencing the file.

* Moved files to appropriate location and updated naming style for
  some of them.

Fixes: #31741

PR-URL: #31792
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
codebytere pushed a commit that referenced this pull request Mar 30, 2020
* Updated cpp style guide file name and location and fixed links to
  this file.

* Updated collaborator guide file name and location and fixed links
  to this file.

* Updated documentation style guide file name and location and updated
  links referencing the file.

* Moved files to appropriate location and updated naming style for
  some of them.

Fixes: #31741

PR-URL: #31792
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lib / src Issues and PRs related to general changes in the lib or src directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc/markdown file organization lacks coherence
6 participants