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.

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

Update style guide for OSS #19

Merged
merged 8 commits into from
Oct 16, 2018
Merged
Changes from 1 commit
Commits
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 reference to OSS
  • Loading branch information
Francis Schmaltz committed Oct 10, 2018
commit c955ad6f4b3f1dd1bf9288f5446f4348fd78fc40
2 changes: 1 addition & 1 deletion STYLEGUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Assume the reader is a busy non-native English speaker.

- Sourcegraph: main product, prefer using this name unless you need to be more precise
- 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 Core: previously was called Sourcegraph Server, this build is the free tier of Sourcegraph built separately from Sourcegraph OSS.
Copy link
Member

Choose a reason for hiding this comment

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

previously was called Sourcegraph Server

This isn't exactly right, since what was previously called "Server" really now maps to both "Core" and "Enterprise Starter" in the new model

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should I remove this?

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, I'd just remove that, because it's not correct. If you prefer, you could replace it with something else that explains how the old "Server" is now both "Core" and "Enterprise Starter" but it's your call on whether that's necessary at all.

- 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
Expand Down