Skip to content

Commit 07f0aff

Browse files
committed
suggest alternatives for open questions
1 parent 769cdae commit 07f0aff

File tree

1 file changed

+13
-4
lines changed
  • designs/2024-plugins.eslint.org-website

1 file changed

+13
-4
lines changed

designs/2024-plugins.eslint.org-website/README.md

+13-4
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,12 @@ Each plugin contains a `README.md` file whose content should be rendered in the
3939
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.
4040

4141
We will also need a main page whose content should be editable in a GitHub repo (as markdown, HTML, or other format).
42-
It is unclear how this will work given that two repos are involved.
42+
It is unclear how this will work given that two repos are involved. Some possible solutions:
43+
* One of the repos will contain the source code for the main page.
44+
* An additional repo will be created for the main page and other shared content.
4345

4446
`eslint` and `eslint.org` use Eleventy to generate web pages from markdown files and other metadata.
45-
The new website could use Eleventy or another similar tool.
47+
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.
4648
Any tool will require a specific configuration that will be kept in the repos along with the documentation pages and other assets for website.
4749
The tooling to build the website pages from the source files will be probably the same.
4850
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.
122124
you can remove this section.
123125
-->
124126

125-
* How can we coordinate one website across multiple repos?
127+
* How can we coordinate one website across multiple repos? Suggested solutions:
128+
* Create an additional repo to maintain the shared logic and content
129+
* Split the shared logic and content between the two plugin repos
126130
* What changes to the infrastructure (not code changes) will be necessary? For example:
127131
* Configure a new site in Netlify
128132
* Create new GitHub tokens for the website to fetch data from the repos
129133
* Register the site URL on search engines
130134
*
131-
* What content will be shown on the main page?
135+
* What content will be shown on the main page? Some ideas:
136+
* A brief introduction to ESLint language plugins
137+
* Links to plugin-specific documentation
138+
* List of sponsors
132139
* When will the website be updated? Common options would be during a release, when the main branch is updated, or using a manual trigger.
133140
* What is the _minimal_ set of features we should have right from the beginning? E.g.
134141
* List of sponsors
@@ -151,6 +158,8 @@ Not relevant for this proposal.
151158

152159
Any help in defining the details of this change or with the subsequent implementation will be greatly appreciated.
153160

161+
To find out which topics will need help exactly, we need answer the open questions in this RFC first.
162+
154163
## Frequently Asked Questions
155164

156165
<!--

0 commit comments

Comments
 (0)