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

fix(docs): hide hidden command flags from docs #1190

Merged
merged 1 commit into from
Sep 1, 2020

Conversation

erezrokah
Copy link
Contributor

@erezrokah erezrokah commented Sep 1, 2020

The staticServerPort flag added to the dev command here is shown in the docs.

This PR fixes the code that generates the docs to remove hidden flags.

@erezrokah erezrokah added the type: bug code to address defects in shipped code label Sep 1, 2020
@erezrokah erezrokah changed the title docs(fix): hide hidden command flags from docs fix(docs): hide hidden command flags from docs Sep 1, 2020
@@ -1,4 +1,7 @@
const path = require('path')
// This dependency is installed in `site/package.json`
// eslint-disable-next-line node/no-extraneous-require
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add some override in .eslintrc.json to omit that ESLint rule inside site/**?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we should move this script to site/scripts, then we won't need the override/disable comment.

I'll open a new issue for that

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@erezrokah erezrokah merged commit d6bc648 into master Sep 1, 2020
@erezrokah erezrokah deleted the docs/fix_hidden_flags branch September 1, 2020 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug code to address defects in shipped code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants