From 07f0affe3fe992bca50a56a8218c43ace722bc1b Mon Sep 17 00:00:00 2001 From: Francesco Trotta Date: Mon, 30 Sep 2024 12:40:43 +0200 Subject: [PATCH] suggest alternatives for open questions --- .../2024-plugins.eslint.org-website/README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/designs/2024-plugins.eslint.org-website/README.md b/designs/2024-plugins.eslint.org-website/README.md index ec7aab82..aedd7f18 100644 --- a/designs/2024-plugins.eslint.org-website/README.md +++ b/designs/2024-plugins.eslint.org-website/README.md @@ -39,10 +39,12 @@ Each plugin contains a `README.md` file whose content should be rendered in the Additionally to the static content in the documentation files, it should be possible to include specific autogenerated information on certain pages like the version number of a package or the date of the last release. We will also need a main page whose content should be editable in a GitHub repo (as markdown, HTML, or other format). -It is unclear how this will work given that two repos are involved. +It is unclear how this will work given that two repos are involved. Some possible solutions: +* One of the repos will contain the source code for the main page. +* An additional repo will be created for the main page and other shared content. `eslint` and `eslint.org` use Eleventy to generate web pages from markdown files and other metadata. -The new website could use Eleventy or another similar tool. +The new website could use Eleventy or another similar tool. Popular alternatives are Jekyll (used by [GitHub Pages](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll)), MkDocs and many more. Any tool will require a specific configuration that will be kept in the repos along with the documentation pages and other assets for website. The tooling to build the website pages from the source files will be probably the same. Instead of duplicating those tools between the two repos, it may be easier to keep them in a single repo (_which one?_). @@ -122,13 +124,18 @@ Not relevant for this proposal. you can remove this section. --> -* How can we coordinate one website across multiple repos? +* How can we coordinate one website across multiple repos? Suggested solutions: + * Create an additional repo to maintain the shared logic and content + * Split the shared logic and content between the two plugin repos * What changes to the infrastructure (not code changes) will be necessary? For example: * Configure a new site in Netlify * Create new GitHub tokens for the website to fetch data from the repos * Register the site URL on search engines * … -* What content will be shown on the main page? +* What content will be shown on the main page? Some ideas: + * A brief introduction to ESLint language plugins + * Links to plugin-specific documentation + * List of sponsors * When will the website be updated? Common options would be during a release, when the main branch is updated, or using a manual trigger. * What is the _minimal_ set of features we should have right from the beginning? E.g. * List of sponsors @@ -151,6 +158,8 @@ Not relevant for this proposal. Any help in defining the details of this change or with the subsequent implementation will be greatly appreciated. +To find out which topics will need help exactly, we need answer the open questions in this RFC first. + ## Frequently Asked Questions