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

add production checklist to docs (close #2561) #3140

Merged
merged 15 commits into from
Oct 23, 2019
Merged

add production checklist to docs (close #2561) #3140

merged 15 commits into from
Oct 23, 2019

Conversation

marionschleifer
Copy link
Contributor

Description

A guide / checklist on what needs to be considered when moving to production.

Affected components

  • Docs

@marionschleifer marionschleifer added s/wip Status: This issue is a work in progress c/docs Related to docs labels Oct 15, 2019
@netlify
Copy link

netlify bot commented Oct 15, 2019 •
edited
Loading

Deploy preview for hasura-docs ready!

Built with commit 8d403d2

https://deploy-preview-3140--hasura-docs.netlify.com

@marionschleifer marionschleifer changed the title structure-production-checklist Production checklist (close #2561) Oct 15, 2019
@hasura-bot
Copy link
Contributor

Review app for commit af50cb6 deployed to Heroku: https://hge-ci-pull-3140.herokuapp.com
Docker image for server: hasura/graphql-engine:pull3140-af50cb61

dsandip
dsandip requested changes Oct 15, 2019
View reviewed changes
docs/graphql/manual/guides/production-checklist.rst Outdated Show resolved Hide resolved
docs/graphql/manual/guides/production-checklist.rst Outdated Show resolved Hide resolved
docs/graphql/manual/guides/production-checklist.rst Outdated Show resolved Hide resolved
docs/graphql/manual/guides/production-checklist.rst Outdated Show resolved Hide resolved
docs/graphql/manual/guides/production-checklist.rst Outdated Show resolved Hide resolved
docs/graphql/manual/guides/production-checklist.rst Outdated Show resolved Hide resolved
marionschleifer and others added 4 commits October 15, 2019 15:15
@marionschleifer @dsandip
Update docs/graphql/manual/guides/production-checklist.rst
e890639 
Co-Authored-By: dsandip <dsandip@users.noreply.github.com>
@marionschleifer @dsandip
Update docs/graphql/manual/guides/production-checklist.rst
87bf814 
Co-Authored-By: dsandip <dsandip@users.noreply.github.com>
@marionschleifer @dsandip
Update docs/graphql/manual/guides/production-checklist.rst
da13d76 
Co-Authored-By: dsandip <dsandip@users.noreply.github.com>
@marionschleifer @dsandip
Update docs/graphql/manual/guides/production-checklist.rst
9d29023 
Co-Authored-By: dsandip <dsandip@users.noreply.github.com>
@hasura-bot
Copy link
Contributor

Review app for commit 9d29023 deployed to Heroku: https://hge-ci-pull-3140.herokuapp.com
Docker image for server: hasura/graphql-engine:pull3140-9d290232

@hasura-bot
Copy link
Contributor

Review app for commit 66bc8ea deployed to Heroku: https://hge-ci-pull-3140.herokuapp.com
Docker image for server: hasura/graphql-engine:pull3140-66bc8ea5

coco98
coco98 previously requested changes Oct 15, 2019
View reviewed changes
docs/graphql/manual/guides/production-checklist.rst Outdated Show resolved Hide resolved
docs/graphql/manual/guides/production-checklist.rst Outdated Show resolved Hide resolved
@hasura-bot
Copy link
Contributor

Review app for commit 2a3d059 deployed to Heroku: https://hge-ci-pull-3140.herokuapp.com
Docker image for server: hasura/graphql-engine:pull3140-2a3d0597

@rikinsk
Copy link
Member

rikinsk commented Oct 18, 2019 •
edited
Loading

Also would like one change. As lot of people ask us about https, we should pull out the content of that section to a separate page in deploying called Enabling HTTPS and just link to it from the production checklist page like we have done with other sections

@rikinsk
Copy link
Member

rikinsk commented Oct 18, 2019 •
edited
Loading

The section titles would be neater if they were all in the imperative form

  • Set admin secret
  • Verify permissions
  • Disable backend APIs
  • Disable Console
  • Set up a request allow list
  • Restrict CORS domains
  • Enable HTTPS
  • Configure logging

@shahidhk
Copy link
Member

@rikinsk made the changes you requested.

@shahidhk shahidhk removed the s/wip Status: This issue is a work in progress label Oct 23, 2019
@shahidhk shahidhk requested a review from dsandip October 23, 2019 03:55
@shahidhk shahidhk requested review from coco98 and rikinsk October 23, 2019 03:55
@shahidhk shahidhk changed the title Production checklist (close #2561) add production checklist to docs (close #2561) Oct 23, 2019
dsandip
dsandip previously approved these changes Oct 23, 2019
View reviewed changes
@rikinsk rikinsk merged commit 7664f1a into hasura:master Oct 23, 2019
@hasura-bot
Copy link
Contributor

Review app https://hge-ci-pull-3140.herokuapp.com is deleted

polRk pushed a commit to polRk/graphql-engine that referenced this pull request Feb 12, 2020
@marionschleifer @polRk
add production checklist to docs (close hasura#2561) (hasura#3140)
ca62516
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rikinsk rikinsk rikinsk approved these changes

@dsandip dsandip dsandip left review comments

@coco98 coco98 Awaiting requested review from coco98

Assignees

@shahidhk shahidhk

Labels
c/docs Related to docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@marionschleifer @hasura-bot @rikinsk @shahidhk @coco98 @dsandip