-
Notifications
You must be signed in to change notification settings - Fork 23
Add a lot more post info to readme #254
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just one small change
General Announcement: | ||
``` | ||
--- | ||
title: title of your announcement |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice examples for each post type
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM @Tjzabel you should also review this
@ct-martin @jrtechs so I'm okay with these additions, but I'm wondering if this information would be better suited for a CONTRIBUTING.md doc? |
@Tjzabel the contributing document appears to currently be more of a "development" document where the readme has information on how to push new content to the website. |
@Tjzabel as stated, CONTRIBUTING was at one point intended to be dev-related, and things like talks are often done by people outside RITlug, I think this is better to keep in README. If we want to re-evaluate that later I'm open to it being discussed in a separate issue |
(since I got asked elsewhere, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess I can approve this PR. I would like to find a way to split up this README so it's not super long, but since I don't have a better alternative, I'm happy to approve it. Thanks 👍
@ct-martin the branch says it's out of date though. Can you fix that before this is merged? |
Done 👍 |
This commit is a first attempt at documenting the FOSS@MAGIC GitHub Pages website, hosted at https://fossrit.github.io. Most of this content is adapted from @ct-martin's documentation written in RITlug/ritlug.github.io#254. Most importantly, it explains how to add content to the website, like announcements, events, and projects. Closes #13. Closes #18. Signed-off-by: Justin W. Flory <[email protected]>
This commit is a first attempt at documenting the FOSS@MAGIC GitHub Pages website, hosted at https://fossrit.github.io. Most of this content is adapted from @ct-martin's documentation written in RITlug/ritlug.github.io#254. Most importantly, it explains how to add content to the website, like announcements, events, and projects. Closes #13. Closes #18. Signed-off-by: Justin W. Flory <[email protected]> :heavy_check_mark: Address @ct-martin's feedback in PR #30 Address parallelism, drop `date` frontmatter from example announcement. Signed-off-by: Justin W. Flory <[email protected]> :heavy_check_mark: Address @10eMyrT's feedback in PR #30 Reorganize structure to move meta information about how the site works to the "About" section. Makes "How to add content" section easier to follow. Signed-off-by: Justin W. Flory <[email protected]>
This commit is a first attempt at documenting the FOSS@MAGIC GitHub Pages website, hosted at https://fossrit.github.io. Most of this content is adapted from @ct-martin's documentation written in RITlug/ritlug.github.io#254. Most importantly, it explains how to add content to the website, like announcements, events, and projects. Closes #13. Closes #18. Signed-off-by: Justin W. Flory <[email protected]> :heavy_check_mark: Address @ct-martin's feedback in PR #30 Address parallelism, drop `date` frontmatter from example announcement. Signed-off-by: Justin W. Flory <[email protected]> :heavy_check_mark: Address @10eMyrT's feedback in PR #30 Reorganize structure to move meta information about how the site works to the "About" section. Makes "How to add content" section easier to follow. Signed-off-by: Justin W. Flory <[email protected]>
Re: #253
Related: RITlug/runbook#78
cc @jrtechs @Tjzabel @jwflory
This makes the README fairly long, but CONTRIBUTING was at some point designated to be for more dev-oriented things about the site IIRC...