Viraji patch 2 #35

viraji · 2020-08-06T12:14:56Z

viraji · 2020-08-07T15:34:18Z

All changes in #14 done as per the agreed upon doc at:
https://docs.google.com/document/d/1KVU44BA37tu-4DXYM99diCeqI6FeDiOFYQp5zLwl8vU/edit?usp=sharing

Loquacity · 2020-08-09T00:25:40Z

contact.md

 * #random: Non-work-related stuff

-### Real-time conference calls
+### Real-Time Conference Calls


Is title case written down as our standard somewhere?

Is title case written down as our standard somewhere?
Not sure, but all other headings were in title case except for these two that I changed - so I changed these as well to make the page consistent.

We follow Google's style guide, which specifies sentence case for titles and headings: https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings

They'll all need to be updated to sentence case, then.

Changed accordingly.

Loquacity · 2020-08-09T00:29:31Z

decisions.md

+For most decisions, a motion is raised within one of TheGoodDocsProject open forums (slack, email list, etc) and those present vote and decide. Should a decision:
+
+    Be strategic or impact many within TheGoodDocsProject,
+    Or if there is contention in deciding, and after discussion at least one member is still strongly against the motion, by continuing to vote -1,
+
+Then the motion should be referred to the PSC.


Suggested change

For most decisions, a motion is raised within one of TheGoodDocsProject open forums (slack, email list, etc) and those present vote and decide. Should a decision:

Be strategic or impact many within TheGoodDocsProject,

Or if there is contention in deciding, and after discussion at least one member is still strongly against the motion, by continuing to vote -1,

Then the motion should be referred to the PSC.

For most decisions, a motion is raised within one of TheGoodDocsProject open forums (slack, email list, etc) and those present vote and decide. A decision should be referred to the PSC only if:

- The decision is strategic or could impact many people within TheGoodDocsProject

- If there is contention in deciding, and after discussion at least one member is still strongly against the motion, by continuing to vote -1

We don't need to worry about fixing this lift-and-shift of the decisions page in this iteration.
It is about to get updated again based on https://docs.google.com/document/d/1hwdA2Gh3ePUFXk4juu7mSoAraxV-BDiarXaPCOY6K3w/edit

camerons · 2020-08-09T10:45:19Z

README.md

@@ -0,0 +1,2 @@
+# thegooddocsproject.github.io
+Forking The Good Docs Project website


As you are doing a lift-and-shift, and this file doesn't contain any value. I'd suggest that we don't include this README.md file. (We can add it later.)

Noted and readme.md deleted.

camerons

I've added some comments.
I'm embarrassingly unskilled at setting up a local web server and hope to work that out soon. (Help welcomed).
I'm hoping someone can view these changes rendered in a web page and confirm they look okay and links work.

camerons · 2020-08-09T10:50:30Z

_includes/nav.html

-  <a href="https://thegooddocsproject.dev/licences.html" style="color:#ffffff;">Licences</a> | 
-  <a href="https://thegooddocsproject.dev/contribute.html" style="color:#ffffff;">Contribute</a> | 
-  <a href="https://thegooddocsproject.dev/contact.html" style="color:#ffffff;">Contact Us</a> | 
+  <a href="https://thegooddocsproject.dev/licences.html" style="color:#ffffff;">Licences</a>


Can we make this hyperlinks relative (licences.html) instead of absolute (https://thegooddocsproject.dev/licences.html)?
Doing so will mean we can test the site in a staging environment, or local environment.
Apply the same comment to other links too.

Relative links weren't applied, initially wouldn't work for preview/staging. I made the adjustments.

camerons · 2020-08-09T10:52:58Z

community.md

+
+
+
+*   [Contribute](https://thegooddocsproject.groups.io/g/contribute.md)


Have you checked these links in a rendered website? I haven't but suspect that contribute.html will find the correct page, but contribute.md will get a 404.

Was unable to test in a rendered website, and so followed existing code. The link has now been changed accordingly.

Tested these links, majority of them go to the groups.io as a .md link and don't load. I see there were new .md files added that match. So I constructed local links.

camerons · 2020-08-09T10:54:58Z

contact.md

 We are nice to each other, in line with our [Code of Conduct](https://github.com/thegooddocsproject/governance/blob/master/CodeOfConduct.md).

-### Who are we?
+### Who are We?


We should use sentence-case as per https://developers.google.com/style/capitalization

viraji

Review changes have now been attended to, please review the PR now.

mgan59

Ran through these changes. Sidenote, all pages were missing front-matter which is required. As a result the build only generate markdown in the _site folder as indicated in this stackoverflow. I have no idea how this site builds/deploys without the front-matter. I went through and added

---
layout: default
---

To all pages which means they now use the _layout/default.html

mgan59 · 2020-08-23T10:59:43Z

_includes/nav.html

-  <a href="https://thegooddocsproject.dev/licences.html" style="color:#ffffff;">Licences</a> | 
-  <a href="https://thegooddocsproject.dev/contribute.html" style="color:#ffffff;">Contribute</a> | 
-  <a href="https://thegooddocsproject.dev/contact.html" style="color:#ffffff;">Contact Us</a> | 
+  <a href="https://thegooddocsproject.dev/licences.html" style="color:#ffffff;">Licences</a>


Relative links weren't applied, initially wouldn't work for preview/staging. I made the adjustments.

mgan59 · 2020-08-23T11:01:16Z

community.md

+
+
+
+*   [Contribute](https://thegooddocsproject.groups.io/g/contribute.md)


Tested these links, majority of them go to the groups.io as a .md link and don't load. I see there were new .md files added that match. So I constructed local links.

Adding new file for Community

Move over content from Announcements: https://github.com/thegooddocsproject/governance/wiki/Announcements

Point Download link to: https://github.com/thegooddocsproject/templates/releases/tag/v0.1

Added a section on Weekly Meeting Minutes calling them from: https://github.com/thegooddocsproject/governance/wiki/Weekly-Meetings

Changed all headings to title case for consistency.

Content to be filled in later.

Description copied off: https://github.com/thegooddocsproject/governance/blob/master/ProjectSteeringCommittee.md

Calling existing links.

Changed file extension from .md to .html.

Deleting the file following Cameron's comment: " As you are doing a lift-and-shift, and this file doesn't contain any value. I'd suggest that we don't include this README.md file. (We can add it later.)"

mgan59 · 2020-08-23T11:21:28Z

There were conflicts with index.md from master. I did a REBASE with a --force push. I'm assuming that these changes are final. But if you need/want to continue working on this branch you will need to rebuild your local branch.

mgan59 · 2020-08-23T11:27:29Z

github has a limit 10 megs, so broke up the review gifs.

Verification Top NavBar has relative links that work

Verification of Community Page -- bunch of additional relative links to new pages (Roles, Decision Logs)

mgan59 · 2020-08-23T11:33:07Z

Gemfile.lock

      public_suffix (>= 2.0.2, < 4.0)
    colorator (1.1.0)
    concurrent-ruby (1.1.5)
    em-websocket (0.5.1)


Not sure how these changes crept in, I had stashed them... if we have a issue with the build I can undo them.

camerons · 2020-08-23T11:48:20Z

Provided my approval based on screenshots from Morgan, review of code changes, and my trust of Morgan's review process.
(I don't have a local version to check.)

Loquacity · 2020-08-24T01:40:21Z

🚀

viraji marked this pull request as ready for review August 7, 2020 15:28

Loquacity reviewed Aug 9, 2020

View reviewed changes

Loquacity requested a review from camerons August 9, 2020 00:30

camerons reviewed Aug 9, 2020

View reviewed changes

camerons suggested changes Aug 9, 2020

View reviewed changes

viraji commented Aug 20, 2020

View reviewed changes

Loquacity approved these changes Aug 20, 2020

View reviewed changes

mgan59 approved these changes Aug 23, 2020

View reviewed changes

viraji and others added 14 commits August 23, 2020 07:17

Create README.md

1b7b4b7

Update nav.html

0f4e692

Create community.md

7fedc4c

Adding new file for Community

Add Press to nav bar

8786a4b

Move over content from Announcements: https://github.com/thegooddocsproject/governance/wiki/Announcements

Update Nav bar

a163246

Point Download link to: https://github.com/thegooddocsproject/templates/releases/tag/v0.1

Add weekly meeting minutes

06f257a

Added a section on Weekly Meeting Minutes calling them from: https://github.com/thegooddocsproject/governance/wiki/Weekly-Meetings

Title case for all headings

23b999f

Changed all headings to title case for consistency.

Add new file for Roles

bc0ffc0

Content to be filled in later.

Add new file for Decisions

b02cb78

Description copied off: https://github.com/thegooddocsproject/governance/blob/master/ProjectSteeringCommittee.md

Add new file for Decision Logs

fc1390c

Calling existing links.

Update contact.md

1fd93f3

Update community.md

942b130

Changed file extension from .md to .html.

Delete README.md

69baac9

Deleting the file following Cameron's comment: " As you are doing a lift-and-shift, and this file doesn't contain any value. I'd suggest that we don't include this README.md file. (We can add it later.)"

fixed some links & added front-matter to pages

c1df469

mgan59 force-pushed the viraji-patch-2 branch from 24e55b8 to c1df469 Compare August 23, 2020 11:19

mgan59 reviewed Aug 23, 2020

View reviewed changes

camerons merged commit 5994f61 into thegooddocsproject:master Aug 23, 2020

mgan59 mentioned this pull request Aug 23, 2020

Use Netlify for branch previews #37

Closed

3 tasks

		@@ -0,0 +1,2 @@
		# thegooddocsproject.github.io
		Forking The Good Docs Project website




		* [Contribute](https://thegooddocsproject.groups.io/g/contribute.md)

Viraji patch 2 #35

Viraji patch 2 #35

Uh oh!

Conversation

viraji commented Aug 6, 2020

Uh oh!

viraji commented Aug 7, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

camerons left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

viraji left a comment

Choose a reason for hiding this comment

Uh oh!

mgan59 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mgan59 commented Aug 23, 2020

Uh oh!

mgan59 commented Aug 23, 2020

Verification Top NavBar has relative links that work

Verification of Community Page -- bunch of additional relative links to new pages (Roles, Decision Logs)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

camerons commented Aug 23, 2020

Uh oh!

Loquacity commented Aug 24, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants