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 workflow and sidebar overview #4468

Merged
merged 9 commits into from Oct 25, 2021

Conversation

planteater
Copy link
Contributor

@planteater planteater commented Oct 22, 2021

  • Adds performance-monitoring article to the "How to use CodeStream" section that goes into depth on the errors integration, and complements the other workflow articles.
  • Adds a codestream-sidebar article as first article in the "CodeStream UI overview" section.
  • Moves my-organization article to the "CodeStream UI overview" section.
  • A little cleanup and tweaking to the codestream-new-relic article in the "Start here" section.

@CLAassistant
Copy link

CLAassistant commented Oct 22, 2021

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added this to Hero to triage in Docs PRs and Issues Oct 22, 2021
@planteater planteater marked this pull request as draft October 22, 2021 18:22
@github-actions
Copy link

Hi @planteater 👋
Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

@gatsby-cloud
Copy link

gatsby-cloud bot commented Oct 22, 2021

Gatsby Cloud Build Report

docs-website-develop

🎉 Your build was successful! See the Deploy preview here.

Build Details

View the build logs here.

🕐 Build time: 25m

@mmfred mmfred moved this from Hero to triage to Drafts in Docs PRs and Issues Oct 22, 2021
@mmfred mmfred added content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers) labels Oct 22, 2021
@planteater planteater marked this pull request as ready for review October 25, 2021 16:39
@paperclypse paperclypse self-requested a review October 25, 2021 16:41
@paperclypse paperclypse self-assigned this Oct 25, 2021
@paperclypse paperclypse moved this from Drafts to Hero to triage in Docs PRs and Issues Oct 25, 2021
@paperclypse paperclypse moved this from Hero to triage to In progress/being reviewed (by Hero or any TW) in Docs PRs and Issues Oct 25, 2021
Copy link
Contributor

@paperclypse paperclypse left a comment

Choose a reason for hiding this comment

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

I've finished reviewing your PR @planteater. I made quite a few changes to bring this content a little more inline with our docs style guide. Let me know if you'd like to review them before I merge this in. Thanks!

@paperclypse paperclypse merged commit 5d8e46b into newrelic:develop Oct 25, 2021
@planteater
Copy link
Contributor Author

@paperclypse - Yeah, we should discuss. If you look over the preview for the performance monitoring article it's become virtually unreadable. I'm not sure what the NR standards are regarding the use of image captions, but this clearly doesn't work.

https://docswebsitedevelop-planteaterdocswebsitefeaturewo.gtsb.io/docs/codestream/how-use-codestream/performance-monitoring/

Also the names of the first two sections in that article don't really make sense. The first section isn't about connecting NR to CS. It's showing that one way to open errors in CS is through the errors inbox. The second section isn't about CodeStream Observability, which one would read as observability about CodeStream. It's about being able to discover errors via CodeStream.

We also need to talk about the "New Relic CodeStream" thing. The application of that seems pretty arbitrary right now. Using it every time we say CodeStream certainly doesn't make sense. Having the overall section in the left rail say that seems reasonable, as well as the "What is New Relic CodeStream?" section, but after that it seems a bit excessive.

@urbiz-nr urbiz-nr removed this from In progress/being reviewed (by Hero or any TW) in Docs PRs and Issues Oct 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants