Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 572046

Summary: Create Writing Style Guide page
Product: Community Reporter: Jacob Harris <jacob.harris>
Component: WebsiteAssignee: Eric Poirier <eric.poirier>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: chris.guindon, eric.poirier, shanda.giacomoni, webmaster
Version: unspecified   
Target Milestone: ---   
Hardware: PC   
OS: Mac OS X   
See Also: https://git.eclipse.org/r/c/www.eclipse.org/org/+/178085
https://git.eclipse.org/c/www.eclipse.org/org.git/commit/?id=4974afaf9ed8b0fde09fe127e06bb680df092310
Whiteboard:

Description Jacob Harris CLA 2021-03-17 14:44:22 EDT
Please add the content from the doc below to a new page for the Writing Style Guide.

https://docs.google.com/document/d/1eDEkNTCu5sY68YhH9Nh-gglMoFraAQ7gjP6D4kOfi6k/edit?usp=sharing

URL: http://eclipse.org/writing-style-guide


Let me know if you need the content in another format or any additional info.
Comment 1 Shanda Giacomoni CLA 2021-03-18 15:31:55 EDT
This page will be listed in the about us menu, so the URL can follow the structure of the other pages there.
Comment 2 Eric Poirier CLA 2021-03-19 08:15:16 EDT
Adding webmaster to this bug to create the repo for this new page.

@webmaster, can you create a new repo (/writing-style-guide) for the eclipse.org website?

Thanks.
Comment 3 Christopher Guindon CLA 2021-03-19 08:35:32 EDT
@Shanda,

Can we consider building this page under an existing section such as /org/ or /org/documents/writting-style-guide?

I would like to avoid creating a new top-level section if not necessary.
Comment 4 Shanda Giacomoni CLA 2021-03-19 08:36:40 EDT
(In reply to Christopher Guindon from comment #3)
> @Shanda,
> 
> Can we consider building this page under an existing section such as /org/
> or /org/documents/writting-style-guide?
> 
> I would like to avoid creating a new top-level section if not necessary.

+1. Whatever we are currently doing works for us.
Comment 5 Eric Poirier CLA 2021-03-19 08:46:15 EDT
(In reply to Shanda Giacomoni from comment #4)
> (In reply to Christopher Guindon from comment #3)
> > @Shanda,
> > 
> > Can we consider building this page under an existing section such as /org/
> > or /org/documents/writting-style-guide?
> > 
> > I would like to avoid creating a new top-level section if not necessary.
> 
> +1. Whatever we are currently doing works for us.

Ok, I will be created the new page at the following location:

/org/documents/writting-style-guide
Comment 6 Eclipse Genie CLA 2021-03-19 10:32:58 EDT
New Gerrit change created: https://git.eclipse.org/r/c/www.eclipse.org/org/+/178085
Comment 7 Eric Poirier CLA 2021-03-19 11:01:18 EDT
I added the new page on staging.

https://staging.eclipse.org/org/documents/writting-style-guide/

username: testuser
password: plaintext

Please review and let me know if there are any changes to be made.

One thing that I noticed is that from the Table of Content there are links for the following sections:

Legal Requirements
Indicating Trademarks and Copyright

But they do not exist in the content. Let me know if I should remove the items from the TOC or there is more content coming.

Thanks!
Comment 8 Jacob Harris CLA 2021-03-19 11:35:03 EDT
Hi Eric, the trademarks section is included under "Representing the Brand", so I just removed the trademarks section at the bottom of the TOC.

I also made "Trademarks and Copyright" the first subheading under "Representing the Brand" in the Google Doc. Can we make that the case on the webpage as well?

Thanks!
Comment 9 Eric Poirier CLA 2021-03-19 11:55:59 EDT
(In reply to Jacob Harris from comment #8)
> Hi Eric, the trademarks section is included under "Representing the Brand",
> so I just removed the trademarks section at the bottom of the TOC.
> 
> I also made "Trademarks and Copyright" the first subheading under
> "Representing the Brand" in the Google Doc. Can we make that the case on the
> webpage as well?
> 
> Thanks!

I made that change to staging.

The changes should appear any minute now.

Let me know if there's anything else.

Thanks.
Comment 10 Jacob Harris CLA 2021-03-19 14:11:01 EDT
Looks good to me, thanks
Comment 11 Eric Poirier CLA 2021-03-19 14:15:09 EDT
(In reply to Jacob Harris from comment #10)
> Looks good to me, thanks

I'll wait for your +1 to merge to production.

Thanks.
Comment 12 Shanda Giacomoni CLA 2021-03-19 14:45:33 EDT
- Add "Business Entities" to the table of contents

- "Format general social media and web references as follows:" Please remove this from the table of contents, and make it a regular paragraph in the body.
Comment 13 Jacob Harris CLA 2021-03-19 14:54:35 EDT
Can we add "Trademarks and Copyright" to the Table of Contents as well?
Comment 14 Eric Poirier CLA 2021-03-19 15:21:37 EDT
(In reply to Shanda Giacomoni from comment #12)
> - Add "Business Entities" to the table of contents
> 
> - "Format general social media and web references as follows:" Please remove
> this from the table of contents, and make it a regular paragraph in the body.

(In reply to Jacob Harris from comment #13)
> Can we add "Trademarks and Copyright" to the Table of Contents as well?

I made those changes and are on staging.

Let me know if there's anything else.

Note that I just pushed those changes and may take a few minutes to load.
Comment 15 Jacob Harris CLA 2021-03-19 15:37:17 EDT
Thanks. Only one last thing: can we make "Trademarks and Copyright" a subheading under "Representing the Brand" in the table of contents (as a bullet point like Tone and Voice).

Good to go after that.
Comment 17 Eric Poirier CLA 2021-03-22 09:00:34 EDT
Hi Jacob,

The Writing style guide is now on production.

https://www.eclipse.org/org/documents/writting-style-guide/

Let me know if there's anything else.

Thanks.
Comment 18 Jacob Harris CLA 2021-03-22 09:09:15 EDT
+1