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

Build: Automatically generate rule index (refs #2860) #6658

Merged
merged 1 commit into from Jul 20, 2016

Conversation

ilyavolodin
Copy link
Member

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

@eslintbot
Copy link

LGTM

@mention-bot
Copy link

@ilyavolodin, thanks for your PR! By analyzing the annotation information on this pull request, we identified @nzakas, @IanVS and @btmills to be potential reviewers

@nzakas
Copy link
Member

nzakas commented Jul 13, 2016

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 _data folder in eslint.github.io) and then just have a Liquid template that creates the HTML?

@ilyavolodin
Copy link
Member Author

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?

@nzakas
Copy link
Member

nzakas commented Jul 13, 2016

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 conf for now. That's where most of our meta-data-type stuff currently is.

@ilyavolodin
Copy link
Member Author

The paragraph starting with:

Rules in ESLint are grouped by category to help you understand their purpose.

@nzakas
Copy link
Member

nzakas commented Jul 15, 2016

@ilyavolodin and what's the problem with that paragraph? You said there's an issue but didn't say what the issue is.

@ilyavolodin
Copy link
Member Author

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?

@eslintbot
Copy link

LGTM

@ilyavolodin ilyavolodin changed the title Chore: Automatically generate rule index (refs #2860) Build: Automatically generate rule index (refs #2860) Jul 18, 2016
@ilyavolodin
Copy link
Member Author

Updated pull request to automatically generate yaml file instead of run ejs template. The rest can be checked into the website directly.

@eslintbot
Copy link

LGTM

@eslintbot
Copy link

LGTM

@nzakas
Copy link
Member

nzakas commented Jul 18, 2016

Ah, I'd say let's just store that first paragraph in the eslint.github.io repo. It doesn't change often enough that I'm too worried about it.

@nzakas
Copy link
Member

nzakas commented Jul 18, 2016

LGTM. We just need to agree on where that paragraph goes. I don't think sticking it in categories.json makes much sense.

@ilyavolodin
Copy link
Member Author

Sounds good. I'll move that paragraph into website repo in the evening.

@eslintbot
Copy link

LGTM

@ilyavolodin
Copy link
Member Author

Removed intro from the json file and moved it into website repository (eslint/archive-website#275) I think this should be good now.

@nzakas
Copy link
Member

nzakas commented Jul 19, 2016

Lgtm. I'll leave merging to you, so you can coordinate the changes in the website repo.

@ilyavolodin
Copy link
Member Author

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.

@alberto alberto deleted the documentation branch August 2, 2016 01:10
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@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 Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants