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

Style guide: Add automated docs editing tips #18830

Merged
merged 1 commit into from
Oct 16, 2024

Conversation

rhetoric101
Copy link
Contributor

No description provided.

@rhetoric101 rhetoric101 self-assigned this Oct 2, 2024
Copy link

github-actions bot commented Oct 2, 2024

Hi @rhetoric101 👋

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.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

Copy link

netlify bot commented Oct 2, 2024

Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit 3c73fb2
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/66fd9a6baa290100084f1c52
😎 Deploy Preview https://deploy-preview-18830--docs-website-netlify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@rhetoric101 rhetoric101 added content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers) labels Oct 2, 2024
title: How to edit automatically-generated docs
---

Some of the teams at New Relic automatically generate docs content from their GitHub repositories. When these automatically-generated docs appear in pull requests for the main docs repository (`https://github.com/newrelic/docs-website`), writers need to edit these somewhat differently than manually generated docs.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not just make the GitHub URL a clickable link?

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.

Looks good to me!

@rhetoric101 rhetoric101 merged commit b260f82 into develop Oct 16, 2024
20 checks passed
@rhetoric101 rhetoric101 deleted the rhs-explain-automated-doc-editing branch October 16, 2024 00:08
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.

2 participants