Name standardization

[jessieay]

Per a conversation in #wg-documentation:

It would be helpful to have naming guidance for Google Docs, GitHub Repos, and Slack channels. Right now, it can be difficult to find things because the naming conventions aren't standardized. It seems like this is a 3 step process:

1. Decide on naming conventions that make sense
2. Edit names of existing docs/repos/channels to conform with conventions decided upon
3. Document naming conventions for future use

[melodykramer]

Would also be helpful to have conventions around where documents should live. We now have several different repositories. What belongs on Google Docs vs. the Hub vs. GitHub etc.

[afeld]

A few "standards" I know of (will add to this list):

• Most Cloud Foundry-related repositories are prefixed with cf- (though some are cloud-foundry-)
• Publicly-joinable Slack channels are suffixed with -public (documented in https://18f.gsa.gov/hub/public_chat/)
• Projects that have multiple channels are prefixed with some common name, a la uscis-

[afeld]

...and by "standards", I mean "conventions".

[mbland]

There's also the convention of prefixing working group repos and Slack channels with wg- and guild working group repos and Slack channels with g-, hence this very repo. I'm also looking to have the repos correspond to 18F Pages sites, such as https://pages.18f.gov/wg-documentation.

[melodykramer]

Would also add that standards for Slack room descriptions would be helpful. @andrewmaier has thought a bit about this.

[mbland]

Sounds like we've got enough of a start for a "Standard names and locations" page in the Hub...or perhaps as a Guide, I'm not sure which would be better. Probably @emileighoutlaw, @kategarklavs, @awfrancisco, @gboone and @elainekamlley might also have ideas in this space, given their work on a team-wide content audit.

[emileighoutlaw]

Ohhh. This is a wonderful conversation and idea. Perhaps we'd want to see how much content this generated before we knew if it warranted a full Guide? I might recommend fleshing out the actual content in a Google Doc and going from there.

On Tue, Sep 15, 2015 at 3:06 PM, Mike Bland notifications@github.com wrote:

Sounds like we've got enough of a start for a "Standard names and locations" page in the Hub...or perhaps as a Guide, I'm not sure which would be better. Probably @emileighoutlaw https://github.com/emileighoutlaw, @kategarklavs https://github.com/kategarklavs, @awfrancisco https://github.com/awfrancisco, @gboone https://github.com/gboone and @elainekamlley https://github.com/elainekamlley might also have ideas in this space, given their work on a team-wide content audit.

— Reply to this email directly or view it on GitHub https://github.com/18F/wg-documentation/issues/3#issuecomment-140503982.

[jessieay]

Created a sub-issue for naming of GitHub naming for repos about "how we like to do stuff" https://github.com/18F/wg-documentation/issues/4

[gboone]

The gut is telling me there's enough content for a page in the hub but not a full guide.

[jessieay]

@gboone @emileighoutlaw @mbland

I agree that a page in the Hub would be all we'd need in order to document some agreed upon naming conventions. I like the idea of calling it "Standard names and locations", as Mike suggested.

[emileighoutlaw]

For whatever reason "Standard names and locations" makes me think we're talking about team members. I would call it something like "Standard document names and locations"

On Wed, Sep 16, 2015 at 12:36 PM, Jessie A. Young notifications@github.com wrote:

@gboone https://github.com/gboone @emileighoutlaw https://github.com/emileighoutlaw @mbland https://github.com/mbland

I agree that a page in the Hub would be all we'd need in order to document some agreed upon naming conventions. I like the idea of calling it "Standard names and locations", as Mike suggested.

— Reply to this email directly or view it on GitHub https://github.com/18F/wg-documentation/issues/3#issuecomment-140796666.

[emileighoutlaw]

Or "How to name and organize documents"

[andrewmaier]

Big +1 to "How to name and organize documents"