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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create code-learning.tsx #1080

Closed
wants to merge 20 commits into from
Closed

Create code-learning.tsx #1080

wants to merge 20 commits into from

Conversation

adaaaam
Copy link
Contributor

@adaaaam adaaaam commented Jun 18, 2020

No description provided.

@adaaaam adaaaam requested a review from a team as a code owner June 18, 2020 16:21
@adaaaam adaaaam requested a review from aileenrose June 19, 2020 04:46
@adaaaam
Copy link
Contributor Author

adaaaam commented Jun 19, 2020

@aileenrose finished with the copy edits but couldn't figure out how to fix the Yelp logo... also padding around the video seems to be different than the other product pages but don't know how to fix.

@adaaaam
Copy link
Contributor Author

adaaaam commented Jun 19, 2020

@adamfrankl2015 @sqs adding you to this PR since Lori wants to review this with you

adaaaam and others added 3 commits June 18, 2020 22:16
- fix yelp image
- fix link to convoy blog post
- remove unused react icons
- fix anchors on other code pages
- reorder code learning
- add helmet to code pages
Copy link
Contributor

@aileenrose aileenrose left a comment

Choose a reason for hiding this comment

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

I made additional updates. Content approved.

@sqs
Copy link
Member

sqs commented Jun 19, 2020

Will review this afternoon

Copy link
Member

@sqs sqs left a comment

Choose a reason for hiding this comment

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

How will this page be used?

I gave some low-level feedback about the language, but I would like to understand more about the audience and goals because I might have some high-level ideas to make this more effective.

<IconItem color="red" icon={HelpIcon} className="py-3">
<p className="text-sans-serif">
New engineering hires don’t know where to look for specific code in large and
distributed libraries and repositories.
Copy link
Member

Choose a reason for hiding this comment

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

What does "distributed" mean in this case?

<div className="col-md-4 mb-4">
<IconItem color="red" icon={HeadSnowflakeIcon} className="py-3">
<p className="text-sans-serif">
Without contextual code intelligence, it’s difficult to find answers to code questions –
Copy link
Member

Choose a reason for hiding this comment

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

should be an em-dash

<h5>
Learn more about how{' '}
<a href="/blog/convoy-improved-their-developer-on-boarding-with-sourcegraph">
Convoy uses Sourcegraph to onboard new developers.
Copy link
Member

Choose a reason for hiding this comment

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

The period should go outside of the link, because the link is not the full sentence. https://about.sourcegraph.com/handbook/communication/style_guide#general

Why learning code is faster with Sourcegraph
</h2>
<p className="text-center mb-5">
Sourcegraph <a href="/universal-code-search">Universal Code Search</a> lets you explore across your
Copy link
Member

Choose a reason for hiding this comment

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

This is a very long sentence. It also is from our POV. Can we shorten it and rephrase it to be more like "With Sourcegraph, you can..." instead of "Sourcegraph lets you"?

<h4>Find definitions and explore references, even across projects</h4>
<p>
See a call to a function you don't recognize? With Sourcegraph, you can see its
documentation and type signature by hovering over it &mdash; and go to its definition in
Copy link
Member

Choose a reason for hiding this comment

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

don't put spaces around em-dashes

documentation and type signature by hovering over it &mdash; and go to its definition in
a single click, across package, dependency, and repository boundaries. Even if your IDE
can do this, Sourcegraph lets you explore code intelligently in your web browser in any
repository on any branch, instantly and without losing your local context to massively
Copy link
Member

Choose a reason for hiding this comment

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

"to massively save time" sounds awkward coming at the end. It is also hard to parse - because "losing your local context to NOUN" is a common phrase, but this "to massively save time" applies to "explore code".

<p>
New hires often spend the majority of their time jumping around unfamiliar parts of the
codebase to build a mental model of the organization’s code. Sourcegraph accelerates
this learning path with{' '}
Copy link
Member

Choose a reason for hiding this comment

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

"learning path" is an awkward phrase. I've never heard that term before, but as written, it sounds like it's a known term.

<div className="col-lg-6 mb-4">
<IconItem className="position-relative" icon={PlaylistAddCheckIcon} color="brand-cyan">
<h4>
Facilitate easier onboarding, with rapidly growing and distributed teams and codebases
Copy link
Member

Choose a reason for hiding this comment

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

"Facilitate" is a throwaway word. Can we just remove it? "Onboard faster"?

"Distributed teams" is mentioned, but we don't explain how that applies. The body text below explains how Sourcegraph helps you with big codebases, but it doesn't explain how it helps when your team is distributed. We could say something about how when you can't tap people on the shoulder, you need a way to find answers on your own. But that's jamming too many ideas into a single paragraph IMO.

Also "distributed" adjective seems to apply to "codebases", which does not make sense.

</div>
<div className="col-lg-6 mb-4">
<IconItem className="position-relative" icon={StopwatchIcon} color="brand-purple">
<h4>Reduce the time to first commit</h4>
Copy link
Member

Choose a reason for hiding this comment

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

I would render this as "time-to-first-commit" to make this easier to parse when reaidng.

New hires often spend the majority of their time jumping around unfamiliar parts of the
codebase to build a mental model of the organization’s code. Sourcegraph accelerates
this learning path with{' '}
<a href="https://about.sourcegraph.com/universal-code-search">universal code search</a>{' '}
Copy link
Member

Choose a reason for hiding this comment

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

UCS is capitalized elsewhere. My strong preference is to not capitalize it (as it's done here).

@aileenrose
Copy link
Contributor

This page is no longer required. Closing PR.

@aileenrose aileenrose closed this Jul 13, 2020
@bretthayes bretthayes deleted the adaaaam-code-learning branch May 13, 2022 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants