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

Missing links formatting in documentation #12894

Closed
revolter opened this issue Feb 8, 2020 · 6 comments
Closed

Missing links formatting in documentation #12894

revolter opened this issue Feb 8, 2020 · 6 comments
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion bug ESLint is working incorrectly help wanted The team would welcome a contribution from the community for this issue

Comments

@revolter
Copy link
Contributor

revolter commented Feb 8, 2020

What did you expect to happen?

These rules have been deprecated in accordance with the deprecation policy, and replaced by newer rules:

What actually happened? Please include the actual, raw output from ESLint.

Links are not formatted in the docs (e.g. https://eslint.org/docs/rules/#deprecated):

These rules have been deprecated in accordance with the [deprecation policy](/docs/user-guide/rule-deprecation), and replaced by newer rules:

Are you willing to submit a pull request to fix this bug?

Depends.

@revolter revolter added bug ESLint is working incorrectly triage An ESLint team member will look at this issue soon labels Feb 8, 2020
@kaicataldo kaicataldo added accepted There is consensus among the team that this change meets the criteria for inclusion good first issue Good for people who haven't worked on ESLint before help wanted The team would welcome a contribution from the community for this issue and removed triage An ESLint team member will look at this issue soon labels Feb 9, 2020
@kaicataldo
Copy link
Member

kaicataldo commented Feb 9, 2020

A PR to fix this would be welcome! I believe the code in question can be found here. When we run a release, all the documentation in this repository is copied over to https://github.com/eslint/website (the generated rules data file can be found here and rendered using this template. It looks like the markdown isn't being converted to HTML - we'll need to figure out why that is.

@revolter
Copy link
Contributor Author

revolter commented Feb 9, 2020

And what is the command that generates the documentation? So I / we have an easier starting point 😃

@kaicataldo
Copy link
Member

Good question! This is the target script we run when we're generating the site (which occurs when we run a release, not on every commit to master).

@revolter
Copy link
Contributor Author

revolter commented Feb 16, 2020

It doesn't generate any HTML file (apart from the fact that the tests fail, and that it can't create its own directories).

For reference, I used npm run generate-release.

@kaicataldo
Copy link
Member

That's correct - we generate the site from Markdown files copied over into https://github.com/eslint/website (using this command).

@kaicataldo kaicataldo removed the good first issue Good for people who haven't worked on ESLint before label Feb 16, 2020
@revolter
Copy link
Contributor Author

Yeah, too complex for a new contributor. But I can tell you that Markdown doesn't work at all on that page.

@nzakas nzakas closed this as completed in 8d5c434 Feb 25, 2020
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Aug 25, 2020
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Aug 25, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion bug ESLint is working incorrectly help wanted The team would welcome a contribution from the community for this issue
Projects
None yet
Development

No branches or pull requests

2 participants