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

Add Code Insights team page #2140

Merged
merged 15 commits into from
Jan 7, 2021
Merged

Add Code Insights team page #2140

merged 15 commits into from
Jan 7, 2021

Conversation

felixfbecker
Copy link
Contributor

The goal of this is to have a page to reference when telling candidates about code insights as one of the different teams that will come out of the web team, to get them excited about this team. I.e. the target audience of this page are candidates.
It would be awesome to attract candidates that are specifically excited about code insights, but that is difficult if we don't have any documentation about this team in the handbook.

Goals were copied from the web team page.

I did not yet add anything from the usual team page structure about contact, processes, members etc, as that doesn't make sense without an operating team yet (and will be "forked" from the web team).

We can add more here that could be attractive (e.g. principles for this feature) but I think this is a good start.

@sourcegraph-bot
Copy link
Contributor

sourcegraph-bot commented Dec 8, 2020

Notifying subscribers in CODENOTIFY files for diff f997b0c...7df0f4e.

Notify File(s)
@nicksnyder handbook/engineering/code-insights/index.md
handbook/engineering/code-insights/screenshot.svg
handbook/engineering/web/index.md
@sourcegraph/web handbook/engineering/web/index.md
@sqs company/goals/index.md

Co-authored-by: Nick Snyder <nick@sourcegraph.com>
Jean du Plessis and others added 2 commits December 10, 2020 08:44
@jeanduplessis jeanduplessis changed the title Add "coming soon" code insights team page Add Code Insights team page Dec 10, 2020
@Joelkw
Copy link
Contributor

Joelkw commented Dec 17, 2020

@christinaforney @nicksnyder I've updated the "goals" section of this to align with what we want goals to be, if one of you can take another look. I'll also be updating the web team goals to this format, and after that will plan to update https://about.sourcegraph.com/company/goals/guidelines with a few relevant points.

(For example, one question I had, based on the examples of cloud and code intel, is whether goal problems should be exclusively feature-based or whether they should include business "problems" – code intel mentions business problems like demonstrating the benefit of existing features, while cloud focuses more on the customer needs/feature value).

handbook/engineering/code-insights/index.md Outdated Show resolved Hide resolved
handbook/engineering/code-insights/index.md Outdated Show resolved Hide resolved
handbook/engineering/code-insights/index.md Outdated Show resolved Hide resolved
handbook/engineering/code-insights/index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@nicksnyder nicksnyder left a comment

Choose a reason for hiding this comment

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

I like the format of milestones and outcomes interleaved.

handbook/engineering/code-insights/index.md Outdated Show resolved Hide resolved

1. Customers can easily create their own custom insights in an intentionally-designed UI.

- **Outcome:** Code insights can move from prototype to beta feature (easy to enable or enabled by default, documented, and supported by the CE team rather than the product team).
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we have an outcome like "We have at least one customer created code insight that is actively used"?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yep, great thought.


- **Outcome:** Code insights features are actively in use by VPs/Directors at 5+ enterprise customers.

1. Customers can easily create their own custom insights in an intentionally-designed UI.
Copy link
Contributor

Choose a reason for hiding this comment

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

in an intentionally-designed UI.

What does this mean?

Copy link
Contributor

Choose a reason for hiding this comment

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

I should have said "dedicated UI" for clarity, even if the this milestone's UI form won't be as "dedicated" as something like the campaigns UI yet.

Copy link
Contributor

Choose a reason for hiding this comment

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

So like a WYSIWYG editor for creating code insights?

Copy link
Contributor

Choose a reason for hiding this comment

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

Sort of, though I don't know what WYSIWYG means when WYS is code and WYG is a visual graph (is Looker/Bigquery what you mean?) because it might still be code-as-UI here. The core of this is "you don't have to go and set it up like a prototype in your settings file" but "there's a UI that we built for this purpose" even if this isn't its final form as we learn about problems or personas who would prefer a different UI.

The simplest first step would be to just pull out the code insights settings code into its own settings-like editor you access somewhere in the UI so you don't get distracted or confused by a busy interface when setting up an insight.

handbook/engineering/code-insights/index.md Show resolved Hide resolved
Joelkw and others added 2 commits January 7, 2021 14:07
@Joelkw
Copy link
Contributor

Joelkw commented Jan 7, 2021

Merging this so that folks can begin referencing it (and I can move this info off the web team page for clarity when the new hires start). @felixfbecker we can continue to make updates, just know you're not back til the new hires start.

@Joelkw Joelkw merged commit c963b58 into main Jan 7, 2021
@Joelkw Joelkw deleted the code-insights-team-page branch January 7, 2021 23:26
@felixfbecker
Copy link
Contributor Author

Looks great! Thanks for making all the updates @Joelkw!

felixfbecker added a commit that referenced this pull request Jan 13, 2021
* Code insights now has a dedicated page (the 2-person team is still "parented" by and linked to from the web team page.)
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.

None yet

6 participants