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

Inconsistent styling of deprecated items #20841

Closed
mscdex opened this issue May 20, 2018 · 8 comments
Closed

Inconsistent styling of deprecated items #20841

mscdex opened this issue May 20, 2018 · 8 comments
Labels
deprecations Issues and PRs related to deprecations. doc Issues and PRs related to the documentations.

Comments

@mscdex
Copy link
Contributor

mscdex commented May 20, 2018

  • Version: master
  • Platform: n/a
  • Subsystem: doc

There are some places in the documentation where deprecated items are not especially highlighted/styled as being deprecated, whereas others have both the red 'deprecated' label in the outline at the top of the page and the big red bar in the actual description. This is the case, no matter what level of deprecation is involved (doc-only, runtime, etc.).

For example: crypto.DEFAULT_ENCODING and crypto.fips are both deprecated, but are not highlighted as such, unlike crypto.createCipher which is.

There may be other instances of this throughout all of the documentation, but these are the first ones I noticed.

@mscdex mscdex added the doc Issues and PRs related to the documentations. label May 20, 2018
@vsemozhetbyt vsemozhetbyt added the deprecations Issues and PRs related to deprecations. label May 20, 2018
@Trott
Copy link
Member

Trott commented May 21, 2018

@nodejs/documentation @nodejs/website

@ryzokuken
Copy link
Contributor

I think we should add the red bars and red labels wherever we missed to add them, but would love to get @vsemozhetbyt's thoughts on this.

@vsemozhetbyt
Copy link
Contributor

vsemozhetbyt commented May 21, 2018

Red labels in TOCs are added automatically by the doc script. To get red bars we just need this blockquote element straight after a heading or a YAML block (if it is present):

> Stability: 0 - Deprecated[: More info if needed.]

@vsemozhetbyt
Copy link
Contributor

As for where they should be added, maybe we need to check deprecations.md against all other docs + maybe to grep "deprecated" in all docs. Not sure, but maybe this is appropriate for the first good issues or Code-and-learn sessions?

@ryzokuken
Copy link
Contributor

ryzokuken commented May 21, 2018

@Trott maybe we could use a few of these for https://www.nodetodo.org/?

@Trott
Copy link
Member

Trott commented May 21, 2018

@Trott maybe we could use a few of these for https://www.nodetodo.org/?

Sure! (Although I bet they will be grabbed faster if you open an issue for each one and label it good first contribution.)

@ryzokuken
Copy link
Contributor

Sure, I'll make a few.

@jasnell
Copy link
Member

jasnell commented Aug 12, 2018

should this remain open?

jasnell added a commit to jasnell/node that referenced this issue Oct 19, 2018
addaleax pushed a commit that referenced this issue Oct 20, 2018
Fixes: #20841

PR-URL: #23761
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
jasnell added a commit that referenced this issue Oct 21, 2018
Fixes: #20841

PR-URL: #23761
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
MylesBorins pushed a commit that referenced this issue Oct 30, 2018
Fixes: #20841

PR-URL: #23761
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
rvagg pushed a commit that referenced this issue Nov 28, 2018
Fixes: #20841

PR-URL: #23761
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
MylesBorins pushed a commit that referenced this issue Nov 29, 2018
Fixes: #20841

PR-URL: #23761
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecations Issues and PRs related to deprecations. doc Issues and PRs related to the documentations.
Projects
None yet
Development

No branches or pull requests

5 participants