Skip to content

Conversation

@justwheel
Copy link
Member

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.

Screenshot of website runbook page, generated from local development environment

@justwheel justwheel added new change Adds new capabilities or functionality docs - infra Infrastructure, web services, and standard operating procedures labels Feb 16, 2020
@justwheel justwheel requested review from a team and ct-martin February 16, 2020 16:03
@justwheel justwheel self-assigned this Feb 16, 2020
@justwheel justwheel requested review from Nolski, kevinassogba and wilfriedE and removed request for a team and wilfriedE February 16, 2020 16:03
@kevinassogba
Copy link
Member

Looks good to me in its current format. The examples have been useful for understanding how to contribute.

Copy link
Member

@ct-martin ct-martin left a comment

Choose a reason for hiding this comment

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

As I'm reading this I'm also realizing the code functionality is no longer the same as the RITlug site from combination of things that weren't merged to the FOSS site after being added to the RITlug site as well as changes for FOSS-specific things that didn't go upstream to the RITlug site. It would be worth explicitly mentioning that somewhere to prevent confusion.

Copy link
Member

@kevinassogba kevinassogba 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. However, I would suggest moving the How to add content section right before How to create announcements. My argument is that the git work flow and the front matter are not directly related to how to add contents. Nevertheless, the examples provided for each section would help readers understand the process of contributing.

justwheel added a commit that referenced this pull request Feb 16, 2020
Address parallelism, drop `date` frontmatter from example announcement.

Signed-off-by: Justin W. Flory <git@jwf.io>
justwheel added a commit that referenced this pull request Feb 16, 2020
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 <git@jwf.io>
@justwheel
Copy link
Member Author

@ct-martin @10eMyrT Thanks for reviewing! I addressed your feedback in commits b4a2131 and 538bace. I'm going to rebase my commits and merge. 🎬

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 <git@jwf.io>

: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 <git@jwf.io>

: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 <git@jwf.io>
@justwheel justwheel merged commit 30d24b4 into master Feb 16, 2020
@justwheel justwheel deleted the add/website branch February 16, 2020 18:17
justwheel added a commit to FOSSRIT/fossrit.github.io that referenced this pull request Feb 20, 2020
This commit follows up on previous Runbook PRs, FOSSRIT/runbook#30 and
FOSSRIT/runbook#32. Now that contributing guidelines and advice about
maintaining this site lives in the Runbook, the duplicated info is
removed from this repo. Instead, the reader is redirected to the
Runbook.

Stay D.R.Y. - Don't Repeat Yourself!

Closes #86.

Signed-off-by: Justin W. Flory <git@jwf.io>
justwheel added a commit to FOSSRIT/fossrit.github.io that referenced this pull request Feb 20, 2020
This commit follows up on previous Runbook PRs, FOSSRIT/runbook#30 and
FOSSRIT/runbook#32. Now that contributing guidelines and advice about
maintaining this site lives in the Runbook, the duplicated info is
removed from this repo. Instead, the reader is redirected to the
Runbook.

Stay D.R.Y. - Don't Repeat Yourself!

Closes #86.

Signed-off-by: Justin W. Flory <git@jwf.io>
justwheel added a commit to FOSSRIT/fossrit.github.io that referenced this pull request Feb 20, 2020
This commit follows up on previous Runbook PRs, FOSSRIT/runbook#30 and
FOSSRIT/runbook#32. Now that contributing guidelines and advice about
maintaining this site lives in the Runbook, the duplicated info is
removed from this repo. Instead, the reader is redirected to the
Runbook.

Stay D.R.Y. - Don't Repeat Yourself!

Closes #86.

Signed-off-by: Justin W. Flory <git@jwf.io>
justwheel added a commit to FOSSRIT/fossrit.github.io that referenced this pull request Feb 25, 2020
This commit follows up on previous Runbook PRs, FOSSRIT/runbook#30 and
FOSSRIT/runbook#32. Now that contributing guidelines and advice about
maintaining this site lives in the Runbook, the duplicated info is
removed from this repo. Instead, the reader is redirected to the
Runbook.

Stay D.R.Y. - Don't Repeat Yourself!

Closes #86.

Signed-off-by: Justin W. Flory <git@jwf.io>
justwheel added a commit to FOSSRIT/fossrit.github.io that referenced this pull request Feb 25, 2020
This commit follows up on previous Runbook PRs, FOSSRIT/runbook#30 and
FOSSRIT/runbook#32. Now that contributing guidelines and advice about
maintaining this site lives in the Runbook, the duplicated info is
removed from this repo. Instead, the reader is redirected to the
Runbook.

Stay D.R.Y. - Don't Repeat Yourself!

Closes #86.

Signed-off-by: Justin W. Flory <git@jwf.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs - infra Infrastructure, web services, and standard operating procedures new change Adds new capabilities or functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document how to post announcements on our website Document FOSS@MAGIC website

4 participants