-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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: renamed doc files to .md, adapted build scripts #4747
doc: renamed doc files to .md, adapted build scripts #4747
Conversation
@@ -7,7 +7,7 @@ JavaScript console mechanism provided by web browsers. | |||
|
|||
The module exports two specific components: | |||
|
|||
* A `Console` class with methods such as `console.log()`, `console.error()` and | |||
* A `ConsoleJefe` class with methods such as `console.log()`, `console.error()` and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo, this should still be Console
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The rest of the changes in this file should also be removed, as this PR is supposed to be about renaming files only.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, it looks like this was done as a branch off the other PR branch so a lot of those other changes were carried over.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah. Give me a second to chop the PRs. Git is funny about certain things.
@eljefedelrodeodeljefe ... I appreciate the new PR to isolate this one change but this will need to be rebased off master and cleaned up to remove the additional changes from the other PR before it could land at all. Also, as @cjihrig and @rvagg indicate, I'm not sure if there's going to be enough consensus to get this landed. Personally I'm fine with renaming these, however. |
No worries. Thank you for bearing with us @eljefedelrodeodeljefe ! The contributions are very welcome, it's just that sometimes it takes some tweaking here and there to get it just right! :-) |
thanks @eljefedelrodeodeljefe, having a place to discuss this separately is a good idea |
@rvagg @jasnell that's alright for me. Just one thing: I'd like to have this closed or "paused" until #4733 is closed or merged. Because then I could just Also currently investigating to rewrite history with this gist. The consequence though would be that the whole history would show the files as |
@eljefedelrodeodeljefe ... understood. I've applied the |
Thx @jasnell. Just a heads up. I am running: git filter-branch --tree-filter '
if [ -f doc/api/_toc.markdown ]
then
mv doc/api/_toc.markdown doc/api/_toc.md
fi' --force HEAD This preserves the history, but changes filenames for all commits that refer to it. With |
that kind of forced push likely wouldn't work for master. We generally limit force pushes only to correct mistakes on landing only the most recent commits. It's hard to say what kind of impact that kind of bulk change would have. |
@eljefedelrodeodeljefe is there a reason for changing the file names in the git history and not just a single commit? |
@jasnell Wouldn't the force push only apply to the PR branch and you would see problematic things in the diff? @thealphanerd this would be the consequence of the above command in order to preserve logs, since |
@jasnell we have talked this PR through in the doc-WG meeting. @thealphanerd pointed out that as soon has you have cleared your backlog for LTS we could have a shot at merging this. Would you give me a ping as soon as this is done? |
Just tried landing this against staging and found the following conflicts
The conflicts themselves are pretty minimal. (edit) |
I am rebasing this right now. |
@thealphanerd can you try again? |
/cc @nodejs/documentation due to active PRs and lots of movements in the docs, quick response would be super appreciated. |
@eljefedelrodeodeljefe github is reporting there are still conflicts to resolve between this and master... have you taken a look at that? Perhaps your master was not synced with upstream when you rebased? |
rebase now green, |
The only conflict now is in the (Edit) |
LGTM. I personally prefer |
I'm actually retroactively going to -0 on this... leaning towards -1 Even thought it was discussed above I didn't really think about the effect of completely wiping the history on the docs... although I'm not convinced that with LTS and stable being fairly in tune that is any less of an aesthetic choice than file name length. It feels like the data could turn out to be useful. |
we'd still have the rev parsing, but what reassured me was @chrisdickinson that there was lots of precedences for removing and renaming before. See 2014. I don't mind too much, would be a nice fresh start though. If CTC decided against it, then we obviously just let it go. |
Is the Docs WG making a case for this? If so, perhaps we should hear a position from them? The .markdown personally bothers me, I prefer .md, but it's pretty trivial and the desire for less churn easily overrides that— However, perhaps the Docs WG has a good case to make on why this is a good thing? I'm of the mind that handing more responsibility for docs/api to the Docs WG is a good thing in general and would prefer not to erect barriers to progress being made by people who are passionate about such things. I know others have a bit more of a mind for stricter quality-control but this is all about give and take. |
This seems like a case where the potential gain is relatively minimal, but the potential loss is also relatively minimal — the gain being that we get to use the more idiomatic extension, It's a tough call, since it's a subtle upside vs. a subtle downside, but I lean towards merging this & backporting — I am not aware of anyone depending on the |
I agree with @chrisdickinson ,
I believe it's just a bit hard for new git users. Most people who contribute to this repo are quite advanced. And what are the chances for new users to track the history of the Although this is a nit PR, I believe the upside > downside. |
landed in 0800c0a edit: worth mentioning that this was tested locally. I build the docs and made sure that the html looks exactly as it should |
@eljefedelrodeodeljefe how long have you been sitting on that graphic? |
I had to download and install Illustrator for an hour or two 😤 |
* doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: #4747 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
* doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: #4747 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Sorry for the late response @eljefedelrodeodeljefe , even git-mv didn't work? |
@stevemao it is |
* doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: #4747 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
* doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: nodejs#4747 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
* doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: #4747 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
@eljefedelrodeodeljefe can you open a backport PR for this against v4.x? Would make landing doc stuff on LTS easier. |
@eljefedelrodeodeljefe ping re backport 😄 |
Sorry, yes, just haven't had a chance to look into the procedure. Will likely do it tomorrow. Sorry for the delay. |
Original commit: 0800c0a doc: git mv to .md * doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: #4747 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Original commit: 0800c0a doc: git mv to .md * doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: #4747 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Original commit: 0800c0a doc: git mv to .md * doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: #4747 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Original commit: 0800c0a doc: git mv to .md * doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: #4747 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Original commit: 0800c0a doc: git mv to .md * doc: rename .markdown references in content * doc: rename to .md in tools * doc: rename to .md in CONTRIBUTING.md PR-URL: #4747 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: techjeffharris Reviewed-By: Johan Bergström <bugs@bergstroem.nu> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
This is for consistency and a little less noise for the eye
as in vm.markdown (2 against 8 chars)
Discussion on: #4726 and #4733
PR-URL:
Reviewed-By:
Reviewed-By: