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.

Sign up for GitHub

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

Jump to bottom

fix(docs): Deploy to DigitalOcean -> fix 404 internal link, fix note layout, fix brand names #25961

Merged
merged 4 commits into from
Jul 31, 2020
Merged

fix(docs): Deploy to DigitalOcean -> fix 404 internal link, fix note layout, fix brand names #25961

merged 4 commits into from
Jul 31, 2020

Conversation

muescha
Copy link
Contributor

@muescha muescha commented Jul 22, 2020 •
edited
Loading

Description

changes:

  • unify brand name: Node -> Node.js
  • unify brand name: gatsby-cli -> Gatsby-CLI
  • unify that the Notes are the same across the doc Note to > **Note:
  • fix code language: bash -> text
  • put filename as title of code block
  • put file name in code fences
  • put A record in code fences
  • unify case Gatsby Site -> Gatsby site
  • fix internal 404 link

Related Issues

@muescha muescha requested a review from a team as a code owner July 22, 2020 20:13
@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Jul 22, 2020
@vladar vladar added status: needs docs review Pull request related to documentation waiting for review and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Jul 24, 2020
AishaBlake
AishaBlake reviewed Jul 31, 2020
View reviewed changes
Copy link

@AishaBlake AishaBlake left a comment

Choose a reason for hiding this comment

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

This looks good for the most part. I fixed a merge conflict and will make a couple of typo corrections and then merge!

docs/docs/deploying-to-digitalocean-droplet.md
@@ -53,15 +53,15 @@ Follow these instructions for installs on an Ubuntu droplet.
sudo n stable
```

`Note`: If you check the version now, you would see the older versions of node and npm from the cache.
You can either exit and restart your terminal or refresh the cache by following commands,
> **Note:** If you check the version now, you would see the older versions of Node.js and npm from the cache.
Copy link

Choose a reason for hiding this comment

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

We're not at all consistent in our treatment of notes like this but I do agree that the backticks should be removed. As long as they're consistent within a single page, I think it's fine!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

we should have a unified syntax for all notes and hints etc in a styleguide

for example in the tutorial it is also not equal over tutorial steps 1-8 :( (#22205)

docs/docs/deploying-to-digitalocean-droplet.md Outdated Show resolved Hide resolved
docs/docs/deploying-to-digitalocean-droplet.md Outdated Show resolved Hide resolved
AishaBlake
AishaBlake approved these changes Jul 31, 2020
View reviewed changes
Copy link

@AishaBlake AishaBlake left a comment

Choose a reason for hiding this comment

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

And now this should be good to go! Thank you once again, @muescha!

@AishaBlake AishaBlake added type: documentation An issue or pull request for improving or updating Gatsby's documentation and removed status: needs docs review Pull request related to documentation waiting for review labels Jul 31, 2020
@AishaBlake AishaBlake merged commit dd0ea0a into gatsbyjs:master Jul 31, 2020
@muescha muescha deleted the muescha/fix/docs-digital-ocean-droplet branch August 1, 2020 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AishaBlake AishaBlake AishaBlake approved these changes

Assignees
No one assigned
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@muescha @AishaBlake @vladar