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

chore:create doc that coveres history and deleted docs #5320

Merged
merged 2 commits into from
Dec 16, 2021

Conversation

bradleycamacho
Copy link
Contributor

This creates a style guide doc that covers accessing doc history and finding deleting files.

@bradleycamacho bradleycamacho added content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers labels Dec 15, 2021
@github-actions
Copy link

Hi @bradleycamacho 👋
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 will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 20 to 30 minutes).

@github-actions github-actions bot added this to Hero to triage in Docs PRs and Issues Dec 15, 2021
@github-actions github-actions bot requested a review from x8a December 15, 2021 20:13
@bradleycamacho bradleycamacho removed the request for review from x8a December 15, 2021 20:14
@bradleycamacho bradleycamacho marked this pull request as draft December 15, 2021 20:14
@bradleycamacho bradleycamacho marked this pull request as ready for review December 15, 2021 20:14
@gatsby-cloud
Copy link

gatsby-cloud bot commented Dec 15, 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: 27m


The easiest way to find a deleted file is to find the pull request that deleted it. There are multiple ways to accomplish this; here are some ideas:

1. Use GitHub's search feature to search for relevany keywords. You can filter search results to only include PRs.
Copy link
Contributor

Choose a reason for hiding this comment

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

relevany :-)

Copy link
Contributor

@barbnewrelic barbnewrelic left a comment

Choose a reason for hiding this comment

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

This is fine. What I would like to know is, if I don't know what the filename is or even when it was deleted, how do I find it? In this case is it best to search Jira and hope that someone listed the PR that deleted it? Or copied the markdown and attached it to the Jira? That's what we used to do in Drupal.

My questions may be more useful for me than others because, for example, with EOL projects, I need to backtrack all over the place for what was documented when, and when was it deleted or replaced by something else. In these situations I often have no idea what was the original file or where it existed before our kazillion redirects. :-)

@bradleycamacho
Copy link
Contributor Author

@barbnewrelic I would recommend using the second approach in that case. As long as you know what the doc was or where it lived in the taxonomy, you can just keep going through release PRs until you find it.

@bradleycamacho bradleycamacho merged commit 8bc5545 into develop Dec 16, 2021
@bradleycamacho bradleycamacho deleted the deleted-files branch December 16, 2021 00:07
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_tw Identifies issues/PRs from Tech Docs writers
Projects
Docs PRs and Issues
Hero to triage
Development

Successfully merging this pull request may close these issues.

None yet

2 participants