electron / website

:electron: The Electron website
https://electronjs.org
Apache License 2.0
119 stars 133 forks source link

Outdated docs on the website #689

Closed nikwen closed 6 hours ago

nikwen commented 6 days ago

The following section is missing from the website version:

https://github.com/electron/electron/blob/f595443a22a01b61750942532cbf38bef12626f3/docs/api/base-window.md#resource-management

erickzhao commented 5 days ago

Seems like we need to backport https://github.com/electron/electron/commit/72802c374b8fa719fbd2ec69cf25079a3db67df3 to 33-x-y :)

erickzhao commented 5 days ago

Opened https://github.com/electron/electron/pull/44874

nikwen commented 5 days ago

Thanks for explaining, @erickzhao! I didn't know docs PRs needed to be backported.

Is there a way to have trop do it or do I have to do it manually?

This will also be relevant for all future PRs of mine that someone merges without applying proper backport tags. (Unfortunately, I can't apply them myself.)

nikwen commented 5 days ago

Thanks again for explaining and for the backport! I also backported another PR to 33 to make it show up on the website: https://github.com/electron/electron/pull/44875

I'll keep this in mind going forward and check that my docs PRs are backported properly.

erickzhao commented 4 days ago

Is there a way to have trop do it or do I have to do it manually?

@nikwen Unfortunately, the best way would be to ping a maintainer or do it manually. Without the correct GitHub permissions, there's no way to use Trop directly.

The e backport command in Electron Build Tools makes this task slightly easier as well.

nikwen commented 4 days ago

Thanks! I didn't know about e backport. Will check it out.

If I ping a maintainer, can they run Trop to do a backport of a PR that has already been merged? Or would I just be putting the burden on them to do a manual backport?

EDIT: Found the answer: Trop can backport after a PR has been merged (source).