Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update style guide for OSS #19

Merged
merged 8 commits into from
Oct 16, 2018
Merged

Update style guide for OSS #19

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
59d057f
Move styleguide.md to root directory
Oct 10, 2018
7870861
Update styleguide to sentence case
Oct 10, 2018
0c6daa9
Update styleguide for OSS release
Oct 10, 2018
c955ad6
Update reference to OSS
Oct 10, 2018
04d7c8c
Updates
Oct 16, 2018
2a31592
Update wording
Oct 16, 2018
79cc86f
Update OSS and extensions callout
Oct 16, 2018
bcaa40a
Remove devops/admin
attfarhan Oct 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update styleguide for OSS release
  • Loading branch information
Francis Schmaltz committed Oct 10, 2018
commit 0c6daa96fbc5dcb4e09338d840d0451590b0ba2b
8 changes: 5 additions & 3 deletions STYLEGUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@ Assume the reader is a busy non-native English speaker.
### Referring to the Product and Features

- Sourcegraph: main product, prefer using this name unless you need to be more precise
- Sourcegraph Server: the form of our product that ships as the `sourcegraph/server` Docker image and runs on a single node
- Sourcegraph Data Center: the form of our product that runs on Kubernetes
- Sourcegraph OSS: the open source code for Sourcegraph. This is **not** the same as Sourcegraph Core.
Copy link
Member

Choose a reason for hiding this comment

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

open-source (with hyphen when used as an adjective)

Also I would not include Sourcegraph OSS in this list, as it's not really a product. You could mention it in a bullet point underneath and say something like "When referring to the build result of the open-source repository, use the name Sourcegraph OSS."

- Sourcegraph Core: previously was called Sourcegraph Server, this build is the free tier of Sourcegraph built separately from Sourcegraph Core.
- Sourcegraph Enterprise Starter: the tier of Sourcegraph that includes some features required for dev-ops/admins to deploy in their corporate environment.
- Sourcegraph Enterprise: the tier of Sourcegraph that includes all enterprise features for dev-ops/admins to deploy Sourcegraph at a large scale.
Copy link
Member

Choose a reason for hiding this comment

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

"Enterprise includes the cluster deployment option formerly called Data Center"

- Sourcegraph.com: the public instance of Sourcegraph for open-source code at https://sourcegraph.com
- Sourcegraph integrations: the general term for our integrations
- Sourcegraph['s] Phabricator integration
Expand All @@ -42,7 +44,7 @@ Assume the reader is a busy non-native English speaker.
- Sourcegraph['s] Firefox add-on
- Sourcegraph['s] Safari extension

When specifically distinguishing between Server and Data Center, it might help to say "the [single-node] Server deployment option" and "the Data Center [cluster] deployment option".
When specifically distinguishing between Core and OSS it is important to note that Core is not built from the OSS code base and OSS does not include tracking data, ability to upgrade, or Sourcegraph extensions. These are included in the Core version of Sourcegraph, that is built from the same code as Sourcegraph Enterprise and has the ability to upgrade later.
Copy link
Member

@dadlerj dadlerj Oct 12, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

does not include tracking data

We don't collect anything from "dev"/oss, but we also haven't ripped this code out of the common codebase. I'd remove this for now.


You don't need to use the full name of the product each time you refer to it, but don't use a shortened name that could be confused with an official name. For example:

Expand Down