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
Build: Automatically generate rule index (refs #2860) #6658
Conversation
LGTM |
@ilyavolodin, thanks for your PR! By analyzing the annotation information on this pull request, we identified @nzakas, @IanVS and @btmills to be potential reviewers |
Hmmm, I'm not a fan of having the HTML for the site in this repo. Is it possible to just create a data file (put into |
Hmm... I guess I could do that. The only issue is first paragraph of text. And removed rules. I can create a separate file in this repository to track removed rules, but I'm not sure what would be a good place to put it in? Any suggestions? |
What first paragraph of text are you referring to? And what is the problem with it? I'd stick the list of removed rules in |
The paragraph starting with:
|
@ilyavolodin and what's the problem with that paragraph? You said there's an issue but didn't say what the issue is. |
Oh, sorry. The issue that I mentioned is that we now keep all of the documentation in this repository. But if we are going to keep the template for index page in the website repository, where do we store that first paragraph? Should it be in this repository, or website? And if it's this one, where should it go? |
9c7b737
to
dde6a99
Compare
LGTM |
Updated pull request to automatically generate yaml file instead of run ejs template. The rest can be checked into the website directly. |
dde6a99
to
5676340
Compare
LGTM |
5676340
to
eeac97e
Compare
LGTM |
Ah, I'd say let's just store that first paragraph in the |
LGTM. We just need to agree on where that paragraph goes. I don't think sticking it in |
Sounds good. I'll move that paragraph into website repo in the evening. |
LGTM |
eeac97e
to
2973aaa
Compare
Removed |
Lgtm. I'll leave merging to you, so you can coordinate the changes in the website repo. |
Website has auto-generated json file checked in. So I think both are ready to be merged in. The reason why I marked one of them with Do not merge, is that if website PR is merged and eslint one is not, next release it's going to get overridden. So I'll merge both now. |
What issue does this pull request address?
Adds a task to release script to automatically generate rule listing page for the website
What changes did you make? (Give an overview)
Added a script that retrieves metadata from all core rules, then runs it through ejb template and copies the output into website folder
Is there anything you'd like reviewers to focus on?
I tested the script locally, but not as part of the release script (since I don't want to release anything). I think it should work, but another set of eyes should be helpful