Skip to content

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

Merged
merged 2 commits into from
Jan 16, 2020
Merged

Add a lot more post info to readme #254

merged 2 commits into from
Jan 16, 2020

Conversation

ct-martin
Copy link
Member

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...

Copy link
Member

@jrtechs jrtechs left a 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
Copy link
Member

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

@jrtechs jrtechs requested a review from Tjzabel January 14, 2020 16:16
Copy link
Member

@jrtechs jrtechs left a 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

@Tjzabel
Copy link
Member

Tjzabel commented Jan 15, 2020

@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?

@jrtechs
Copy link
Member

jrtechs commented Jan 15, 2020

@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.

@ct-martin
Copy link
Member Author

@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

@ct-martin
Copy link
Member Author

(since I got asked elsewhere, CONTRIBUTING is a markdown file similar to README; it's not changed in this issue, but its purpose is related/relevant)

Copy link
Member

@Tjzabel Tjzabel left a 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 👍

@Tjzabel
Copy link
Member

Tjzabel commented Jan 16, 2020

@ct-martin the branch says it's out of date though. Can you fix that before this is merged?

@ct-martin
Copy link
Member Author

Done 👍

@jrtechs jrtechs merged commit ded047e into RITlug:master Jan 16, 2020
justwheel added a commit to FOSSRIT/runbook that referenced this pull request Feb 16, 2020
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]>
justwheel added a commit to FOSSRIT/runbook that referenced this pull request Feb 16, 2020
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]>
justwheel added a commit to FOSSRIT/runbook that referenced this pull request Feb 16, 2020
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants