search

hasura / ddn-docs

Repository for the Hasura DDN version of docs
https://hasura.io/docs
2 stars 6 forks source link

Permissions and JWT testing for new Getting Started #543

Closed seanparkross closed 2 months ago

seanparkross commented 2 months ago

Description

Permissions and JWT testing for new Getting Started.

Merging to: rob/docs/audit-gs-docs

Quick Links 🚀

/getting-started/build/add-permissions

🤖 DX: Assertion Tests

cloudflare-workers-and-pages[bot] commented 2 months ago

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: f701c4c
Status: ✅  Deploy successful!
Preview URL: https://3b705c83.v3-docs-eny.pages.dev
Branch Preview URL: https://sean-audit-gs-docs-auth.v3-docs-eny.pages.dev

View logs

robertjdominguez commented 2 months ago

Redirects 🔀

Hey, @robertjdominguez & @seanparkross — the following redirects will be needed for deployment:

# TEST ME: https://stage.hasura.io/docs/3.0/auth/authentication/role-emulation/
location = /docs/3.0/auth/authentication/role-emulation/ {
    return 301 https://$host/docs/3.0/auth/authentication/role-emulation/.wip;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_clickHouse/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_clickHouse/_01-connect-a-source/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_graphql/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_graphql/_01-connect-a-source/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_mongoDB/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_mongoDB/_01-connect-a-source/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_openAPI/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_openAPI/_01-connect-a-source/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_postgreSQL/_01-connect-a-source/
location = /docs/3.0/getting-started/build/03-connect-to-data/_databaseDocs/_postgreSQL/_01-connect-a-source/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
# TEST ME: https://stage.hasura.io/docs/3.0/getting-started/build/05-add-permissions/
location = /docs/3.0/getting-started/build/05-add-permissions/ {
    return 301 https://$host/docs/3.0/OG-FILE-WAS-DELETED-REPLACE-ME-WITH-NEW-LOCATION;
}
robertjdominguez commented 2 months ago

Hey, @seanparkross :wave:

Thanks for this PR! Since you changed docs files, our automated Action assigned Sean as your reviewer :tada:

Before Sean looks over the changes, we ask you to take care of a couple of items:

The docs team aims to get all PRs reviewed within 48 hours of your team doing a review in the form of a content pass. Let Sean know the level of urgency on Slack :+1:

robertjdominguez commented 2 months ago

DX: Assertion Testing

✅ Diff

The updates from v1 to v2 in the authentication configuration (AuthConfig) are well documented. The removal of 'allowRoleEmulationBy: admin' in various auth-config.hml files reflects a move towards a more secure and production-ready setup by eliminating role emulation, which is suitable for testing environments only. The 'version: v2' update indicates an adherence to updated specifications or standards. Furthermore, the changes related to the JWT setup instructions ensure the documentation remains current and in alignment with the latest practices for setting up a JWT for testing purposes.

❌ Integrated

While the updates to the individual JWT and webhook authentication pages are clear, the overall consolidation of the authorization information and the removal of role emulation sections might leave a gap for users who are upgrading from an earlier version or those who still rely on role emulation for testing. Without a detailed migration guide or clear information on the alternatives to role emulation, users might be confused about how to transition smoothly to the new setup. Additionally, updating sections that point to removed files without providing an alternative reference can reduce the usability of the documentation.

robertjdominguez commented 2 months ago

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 45%, saving 186.57 KB.

Filename Before After Improvement Visual comparison
static/img/get-started/beta/console-query-with-permissions.png 414.44 KB 227.88 KB -45.0% View diff

152 images did not require optimisation.

robertjdominguez commented 2 months ago

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 47.6%, saving 191.97 KB.

Filename Before After Improvement Visual comparison
static/img/get-started/beta/jwtio-token-generation.png 403.41 KB 211.44 KB -47.6% View diff

153 images did not require optimisation.

robertjdominguez commented 2 months ago

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 47.8%, saving 200.85 KB.

Filename Before After Improvement Visual comparison
static/img/get-started/beta/console-query-with-permissions.png 420.39 KB 219.54 KB -47.8% View diff

153 images did not require optimisation.

robertjdominguez commented 2 months ago

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 42.5%, saving 326.13 KB.

Filename Before After Improvement Visual comparison
static/img/get-started/beta/console-query-with-permissions.png 453.81 KB 240.90 KB -46.9% View diff
static/img/get-started/beta/jwtio-token-generation.png 313.38 KB 200.16 KB -36.1% View diff

152 images did not require optimisation.