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.

Sign up for GitHub

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

Jump to bottom

docs: consolidate info docs #32964

Merged
merged 4 commits into from Feb 28, 2022
Merged

docs: consolidate info docs #32964

merged 4 commits into from Feb 28, 2022

Conversation

erickzhao
Copy link
Member

@erickzhao erickzhao commented Feb 18, 2022 •
edited

Description of Change

The main driver for this documentation change is that our docs/tutorial/support.md is not very focused and contains smatterings of information about many different things related to "support".

  • Our supported major version policy.
  • How to get community support on Electron.
  • Our supported platforms.

This was kind of messy so I did a few things:

  • Moved the version stuff to "Electron Release Timelines" and renamed that doc to "Electron Releases"
  • Removed the community support stuff since it was a duplicate of https://electronjs.org/community
  • Moved the supported platform notices to README.md

Since I touched README.md... I realized there were a bunch of outdated things that I went to fix:

  • GitHub trademark license is no longer relevant. Updated to mention OpenJS.
  • Removed archived repos from the resources section.
  • Fixed the China mirror link.
  • We don't use electron-i18n anymore.

cc @VerteDinde @mlaurencin

Future Work

IMO, this kind of information would be better suited for a single source of truth (JSON file?) and displayed somewhere on the website rather than in a versioned tutorial doc.

Checklist

Release Notes

Notes: none

@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Feb 18, 2022
@erickzhao erickzhao requested review from a team February 18, 2022 01:10
erickzhao
erickzhao commented Feb 18, 2022
View reviewed changes
docs/tutorial/electron-timelines.md
| 16.0.0 | 2021-Sep-23 | 2021-Oct-20 | 2021-Nov-16 | M96 | v16.9 | ✅ |
| 17.0.0 | 2021-Nov-18 | 2022-Jan-06 | 2022-Feb-01 | M98 | v16.13 | ✅ |
| 18.0.0 | 2022-Feb-03 | 2022-Mar-03 | 2022-Mar-29 | M100 | TBD | ✅ |
| 19.0.0 | 2022-Mar-31 | 2022-Apr-30 | 2022-May-24 | M102 | TBD | ✅ |
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please help me fill in this table line. I kind of winged the dates.

I also added the needs-manual-bp tags because the "supported" versions here will be different for each major version. I assume we want this table to be accurate once Electron 19 hits stable?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't want to put E19 dates out yet. Usually we just publicize one version out (the beta one).

E18 is in beta, which means we are supporting E15 still. E18-E15.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The existing automation for support.md includes 19-x-y as a supported release branch on main, so I figure it should at least be in this table, even with the dates removed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes sense!

@electron/wg-releases do we want to start putting dates for more than one version out? It'll make the table look more filled and consistent.
If so, E19 are these:
alpha 2022-Mar-31
beta 2022-Apr-28
Stable 2022-May-24

Note once E19 goes stable, we are going back to 3 supported versions (E19-E17).

@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Feb 19, 2022
VerteDinde
VerteDinde approved these changes Feb 28, 2022
View reviewed changes
Copy link
Member

@VerteDinde VerteDinde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - we'll have to fast follow this with a PR that removes the automation that bumps the supported versions in support.md, I can take care of that. Will mark it related to this PR

@VerteDinde VerteDinde merged commit 1e50f7d into electron:main Feb 28, 2022
@release-clerk
Copy link

release-clerk bot commented Feb 28, 2022

No Release Notes

@jkleinsc jkleinsc mentioned this pull request Mar 24, 2022
Merged
@commit-lint commit-lint bot mentioned this pull request Apr 18, 2022
Open
bavulapati pushed a commit to bavulapati/electron that referenced this pull request Apr 29, 2022
@erickzhao @bavulapati
docs: consolidate info docs (electron#32964)
6ac70e0 
* docs: consolidate info docs

* fill in table

* more newlines to admonitions

* update china mirror thing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sofianguy sofianguy sofianguy left review comments

@VerteDinde VerteDinde VerteDinde approved these changes

Assignees
No one assigned
Labels
documentation 📓 no-backport semver/none
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@erickzhao @sofianguy @VerteDinde