update readme and documentation #1124
Conversation
|
See the policies branch to preview readme and other documentation pages on github: https://github.com/USRSE/usrse.github.io/tree/policies |
| It's helpful to write out a listing of timezones in the content, e.g.,: | ||
|
|
||
| ```md | ||
| The next community call will be on August 12, 2021 at 12ET/11CT/10MT/9PT. |
There was a problem hiding this comment.
We should figure out what format we want to use for these. I personally don't like these without a space between the number and the timezone... But maybe this is what others decided we are doing to use?
There was a problem hiding this comment.
I just grabbed a recent example - happy to put in a different format if there are suggestions
There was a problem hiding this comment.
I don't think we've had any agreement on this, but the website group could make the decision
There was a problem hiding this comment.
I think there should at least be spaces and the time zone abbreviations should be complete, e.g., "August 12, 2021 at 12pm EDT/11am CDT/10am MDT/9am PDT".
Co-authored-by: Daniel S. Katz <[email protected]>
Co-authored-by: Daniel S. Katz <[email protected]>
Co-authored-by: Daniel S. Katz <[email protected]>
Co-authored-by: Daniel S. Katz <[email protected]>
Co-authored-by: Daniel S. Katz <[email protected]>
Co-authored-by: Daniel S. Katz <[email protected]>
|
Presumably due to multiple original authors, there's various inconsistency as one reads through, e.g, do we capitalize JSON, RSS, URL, etc.? Do we hyphenate US-RSE? Do we put backticks around literal filenames? Perhaps outwith this PR, as a followup, we ought to decide such style stuff then do a round of fixes. (Could be right alongside fixing how we specify times/zones.) |
|
|
||
| cc @usrse-maintainers |
There was a problem hiding this comment.
I'm pretty sure usrse-maintainers will still be notified on PR creation without this line but I just want to confirm that.
There was a problem hiding this comment.
I don't know that they will be notified, but regardless, that's not quite the right group. When sorting out the groups, I made usrse-maintainers non-SC members with merge permissions, and then there's a SC group as well. I think we want people putting the PR on Slack when they're ready for review? Especially because people need to preview and check tests first (so don't really want to alert folks until it's really ready). But maybe we do want some @ a group in the template?
Co-authored-by: Mark T. B. Carroll <[email protected]>
Co-authored-by: Mark T. B. Carroll <[email protected]>
Co-authored-by: Mark T. B. Carroll <[email protected]>
|
On the style inconsistencies - yes, it's been written by multiple people. I didn't do a full copyedit - just tried to sort out the info as the primary goal. Anyone who wants to do a consistency/editing pass would be appreciated, but perhaps after the PR is merged would be best. Want to get general buy-in on the reorganization, basic content, and policy revisions first. |
Co-authored-by: Miranda Mundt (she/her) <[email protected]>
Co-authored-by: Miranda Mundt (she/her) <[email protected]>
Co-authored-by: Miranda Mundt (she/her) <[email protected]>
Co-authored-by: Miranda Mundt (she/her) <[email protected]>
|
I'm not sure about the images on tests_ci.md. I'm going to go ahead and merge everything here though, and we can address any remaining issues with additional PRs. I left the issue of multiple timezone formatting to decide later #1126 |
This PR has a series of changes to help with website update procedures, clarify policies, break up the documentation into smaller pieces, and update the PR template.