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

doc: README: Add documentation on downloads and release cycle #16345

Merged
merged 2 commits into from
May 17, 2021
Merged

doc: README: Add documentation on downloads and release cycle #16345

merged 2 commits into from
May 17, 2021

Conversation

miri64
Copy link
Member

@miri64 miri64 commented Apr 16, 2021

Contribution description

This offers an alternative to #16087 for the documentation of our release cycle. The README is amended with a short section how to download RIOT and the doxygen documentation receives a page about our release cycle in detail

Testing procedure

Read, doxygen should build properly and all the links should work (except the [release cycle] link; for that https://doc.riot-os.org needs to be updated with this PR first).

Issues/PRs references

Alternative to #16087.

@miri64 miri64 added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Process: needs >1 ACK Integration Process: This PR requires more than one ACK Process: release cycle Integration Process: The PR is connected to the release cycle (e.g. release notes) CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Apr 16, 2021
@miri64 miri64 requested a review from jia200x as a code owner April 16, 2021 15:46
@miri64 miri64 mentioned this pull request Apr 16, 2021
Closed
@miri64 miri64 force-pushed the doc/enh/release-cycle branch from 36dd4c2 to 0d8f413 Compare April 16, 2021 15:48
@MrKevinWeiss
Copy link
Contributor

For what it matters I like this version better. The initial README should be giving an idea where to get detailed information and the docs are for the details.

fjmolinas
fjmolinas approved these changes May 4, 2021
View reviewed changes
Copy link
Contributor

@fjmolinas fjmolinas left a comment

Choose a reason for hiding this comment

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

ACK, I prefer this version than this alternative

@miri64
Copy link
Member Author

miri64 commented May 4, 2021

Needs one more ACK due to the README change.

@miri64
Copy link
Member Author

miri64 commented May 4, 2021

May I squash in the meantime?

@fjmolinas
Copy link
Contributor

May I squash in the meantime?

yep

@miri64
Copy link
Member Author

miri64 commented May 4, 2021

May I squash in the meantime?

yep

Mixed messages ^^ (due to the 👎 emoji on the post)

miri64 added 2 commits May 4, 2021 11:54
@miri64
README: Add documentation on downloading RIOT
8f60f29 
Signed-off-by: Martine Lenders <m.lenders@fu-berlin.de>
@miri64
doxygen: add release cycle page
af7152e
@miri64 miri64 force-pushed the doc/enh/release-cycle branch from 40dc40d to af7152e Compare May 4, 2021 09:54
@miri64
Copy link
Member Author

miri64 commented May 4, 2021

Squashed.

@fjmolinas
Copy link
Contributor

May I squash in the meantime?

yep

Mixed messages ^^ (due to the -1 emoji on the post)

Sorry wrony emoji

jeandudey
jeandudey approved these changes May 12, 2021
View reviewed changes
Copy link
Contributor

@jeandudey jeandudey left a comment

Choose a reason for hiding this comment

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

ACK. Improves the situation for newcomers looking for this information 👍🏻

Rendered docs:

@miri64 miri64 merged commit 0978084 into RIOT-OS:master May 17, 2021
@miri64 miri64 deleted the doc/enh/release-cycle branch May 17, 2021 07:48
@MrKevinWeiss MrKevinWeiss added this to the Release 2021.07 milestone Jul 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fjmolinas fjmolinas fjmolinas approved these changes

@jeandudey jeandudey jeandudey approved these changes

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@kaspar030 kaspar030 Awaiting requested review from kaspar030

@leandrolanzieri leandrolanzieri Awaiting requested review from leandrolanzieri

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

Assignees
No one assigned
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Process: needs >1 ACK Integration Process: This PR requires more than one ACK Process: release cycle Integration Process: The PR is connected to the release cycle (e.g. release notes) Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Milestone
Release 2021.07
Development

Successfully merging this pull request may close these issues.
4 participants
@miri64 @MrKevinWeiss @fjmolinas @jeandudey