Skip to content
This repository was archived by the owner on Sep 11, 2025. It is now read-only.

3.3 blog post improvements #109

Merged
ryan-blunden merged 15 commits into from
Apr 23, 2019
Merged

3.3 blog post improvements #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
54e5be8
3.3 blog post improvements
ryan-blunden Apr 22, 2019
2cafc5f
Merge branch 'master' into rb/3.3-post-v2
ryan-blunden Apr 22, 2019
b5f1bf6
STYLEGUIDE fixes
ryan-blunden Apr 23, 2019
16a9be5
Applied regexps suggested change
sqs Apr 23, 2019
ef18cb8
Applied Sentry commit suggestion
sqs Apr 23, 2019
318662e
Applied change of tool-tips to tooltips
sqs Apr 23, 2019
965ee8a
Applied "go to definition" summary suggestion
sqs Apr 23, 2019
aa1732e
Applied changing of example function from `throw(` to `open(`
sqs Apr 23, 2019
e00a6c6
Applied "Tips for making" suggestion
sqs Apr 23, 2019
66de33e
Applied Bitbucket "enabling" => "granting permissions" suggestion
sqs Apr 23, 2019
fd9f6cf
Applied "enable extension globally" docs link change
sqs Apr 23, 2019
e88dc83
Added period.
ryan-blunden Apr 23, 2019
28fa281
Updated STYLEGUIDE.md
ryan-blunden Apr 23, 2019
11673a1
Removed JSON for "enable extension globally".
ryan-blunden Apr 23, 2019
d113304
Update blogposts/announcing-sourcegraph-3.3.md
sqs Apr 23, 2019
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
9 changes: 8 additions & 1 deletion STYLEGUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Our copy should be:
- Punctuation goes outside of quotation marks, except in marketing when displaying a quote.
- Use the most popular US English spelling and phrasing.
- Prefer the serial comma in lists, except where ambiguity would be introduced by including it.
- No spaces between two terms separated by a slash ("a/b", not "a / b").

### Clarity

Expand All @@ -43,6 +44,8 @@ Assume the reader is a busy non-native English speaker.
- Sourcegraph['s] Firefox add-on
- Sourcegraph['s] Safari extension

- Code intel reserved for describing benefit of using Sourcegraph holistically or from the organization's point of view. If referring to "go to definition" for example, use "code navigation" (not "code intel").
Copy link
Member

@sqs sqs Apr 23, 2019

Choose a reason for hiding this comment

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

Whoops, I meant to move the style guide from this repo to https://sourcegraph.com/github.com/sourcegraph/sourcegraph@master/-/blob/doc/dev/style_guide.md, but I didn't push apparently

Copy link
Member

@sqs sqs Apr 23, 2019

Choose a reason for hiding this comment

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

will finish that soon


When referring to the build result of the open-source repository, use the name Sourcegraph OSS.

When specifically distinguishing between Core and Sourcegraph OSS it is important to note that Core is not built from the open-source code base and Sourcegraph OSS does not include the ability to upgrade, or access the extension registry on sourcegraph.com. 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.
Expand Down Expand Up @@ -133,13 +136,17 @@ For consistency, all examples should use the following names (as appropriate).
- Configuration not config ("config" is OK in paths and navigation links)
- Setup is a noun, "set up" is a verb ([see notaverb.com/setup](http://notaverb.com/setup), although see [note on descriptivism](#note))
- Prefer "sign in" to "log in" (also: "login" is a noun, "log in" is a verb)
- Sourcegraph (not "sourcegraph" or "SourceGraph")
- Sourcegraph (not "sourcegraph" or "SourceGraph", or "sg")
- URL (not "url")
- OpenID Connect (not "OIDC")
- PostgreSQL (not any of: Postgres, postgres, PgSQL, Postgresql, PostGres, etc.)
- Go (not "Golang")
- macOS (not any of: OS X, OSX, MacOS, MacOSX, etc.)
- Capitalize as shown (in prose): Docker, Bitbucket, GitHub, React, Git, JavaScript, TypeScript (all according to the intent of the creator)
- Prefer "go to definition" (not "jump to definition", "jump-to-def", or "j2d")
- Prefer regexp ("not regex" or "regular expressions")
- Prefer "call site" (not "callsite")
- Prefer "tooltips" (not "tool-tips")

### "Contact us" Language

Expand Down
Loading