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

[docs][recipes] Prepare for deployment #15319

Closed
marcysutton opened this issue Jul 2, 2019 · 3 comments
Closed

[docs][recipes] Prepare for deployment #15319

marcysutton opened this issue Jul 2, 2019 · 3 comments
Labels
help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@marcysutton
Copy link
Contributor

marcysutton commented Jul 2, 2019

Summary

To improve key learning workflows in the Recipes section of the docs, there should be a short, actionable recipe on preparing a site for deployment. This would include generating your site with gatsby build and adding an optional path prefix (with a quick note about why you would even need/want that option).

Recipes now follow this format:

  • Requirements or prerequisites
    • Gatsby CLI
    • A Gatsby site
  • Step-by-step instructions
  • Relevant links to any relevant information

This recipe should go into the "Deploying" section of docs/docs/recipes.md, replacing the existing text. Docs URLs to gatsbyjs.org should be relative. There is a recipe template in the contributing docs: https://www.gatsbyjs.org/contributing/docs-templates/#recipes

For reference, the new recipe collection is also listed in a spreadsheet: https://docs.google.com/spreadsheets/d/1yNUQi_-3TsuDtE98hCIJQvLZ6X1YHlDmC-EJwOGxiHk/edit#gid=1252007048

@marcysutton marcysutton added help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation effort: low labels Jul 2, 2019
@tom-raley
Copy link
Contributor

I’d like to take this on if no one else has started yet!

@marcysutton
Copy link
Contributor Author

Go for it, @tom-raley! Thanks for offering!

@marcysutton
Copy link
Contributor Author

Closed with #15605

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

2 participants