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

Rahul/oct18/platformfeatures #720

Merged
merged 17 commits into from
Nov 15, 2024
Merged

Conversation

rahulagarwal13
Copy link
Contributor

Description 📝

Quick Links 🚀

Assertion Tests 🤖

@hasura-bot
Copy link
Contributor

Error testing the assertions. Check the logs.

@hasura-bot
Copy link
Contributor

@rahulagarwal13 Thanks for your PR! I've assigned @robertjdominguez to review it.

@hasura-bot
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 33.5%, saving 503.91 KB.

Filename Before After Improvement Visual comparison
static/img/get-started/comments_builds.png 343.59 KB 269.06 KB -21.7% View diff
static/img/get-started/comments_insights.png 276.21 KB 206.16 KB -25.4% View diff
static/img/get-started/comments_notification.png 75.33 KB 53.73 KB -28.7% View diff
static/img/get-started/comments_subgraph.png 89.74 KB 67.61 KB -24.7% View diff
static/img/get-started/dashboard_print.png 279.58 KB 164.58 KB -41.1% View diff
static/img/get-started/dashboard_productivity.png 87.47 KB 44.83 KB -48.8% View diff
static/img/get-started/dashboard_reliability.png 80.38 KB 41.43 KB -48.5% View diff
static/img/get-started/dashboard_security.png 190.29 KB 105.15 KB -44.7% View diff
static/img/get-started/dashboard_usage.png 79.59 KB 45.71 KB -42.6% View diff

192 images did not require optimisation.

Copy link

cloudflare-workers-and-pages bot commented Oct 18, 2024

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: b40a6cb
Status: ✅  Deploy successful!
Preview URL: https://b7e63fe0.v3-docs-eny.pages.dev
Branch Preview URL: https://rahul-oct18-platformfeatures.v3-docs-eny.pages.dev

View logs

This stubs out a clearer template for users:
* Each section should be modeled after the `Security and Governance` heading
* A single-sentence explanation + a few sentences of detail are provided for users
* Availability is moved to an admonition
* Alt text is descriptive

These combine for a better, more grokkable UX; note the right-hand TOC for a quick refernce.
Comment on lines 32 to 59
## Security and Governance

:::tip Available on

Security and Governance reports are available on DDN Free plans and up.

:::

### Public Endpoint Alert

Quickly identify any models that are publicly exposed without authentication.

This feature helps prevent unauthorized access by providing clear notifications of potential vulnerabilities. By
scanning your API endpoint for any publicly accessible models, you’ll be alerted if any part of your system is not
secured, allowing you to take immediate action.

### Security Issue Resolution

A step-by-step guide to resolve detected security issues.

This feature provides actionable insights on how to secure your supergraph, helping you implement necessary changes
without guesswork. Each detected issue is paired with recommended fixes to improve the overall security of your API.

<Thumbnail
src="/img/get-started/dashboard_security.png"
alt="The Security and Governance report showing that NoAuth mode makes the API publicly accessible"
width="1000"
/>
Copy link
Collaborator

Choose a reason for hiding this comment

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

@julian-mayorga and @rahulagarwal13 — please note what I did here to make things clearer. You can see more details of the step-by-step we need to replicate for the other subheadings in this commit's description.

@julian-mayorga
Copy link
Contributor

@robertjdominguez I updated the PR with the latest changes in platform report. Let me know if you need further changes 🙏

@hasura-bot
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 43.3%, saving 291.65 KB.

Filename Before After Improvement Visual comparison
static/img/get-started/dashboard_auth.png 119.70 KB 75.20 KB -37.2% View diff
static/img/get-started/dashboard_docs.png 44.39 KB 26.47 KB -40.4% View diff
static/img/get-started/dashboard_permissions.png 160.65 KB 90.16 KB -43.9% View diff
static/img/get-started/dashboard_productivity.png 179.84 KB 94.23 KB -47.6% View diff
static/img/get-started/dashboard_reliability.png 82.30 KB 46.77 KB -43.2% View diff
static/img/get-started/dashboard_request_trend.png 86.06 KB 48.48 KB -43.7% View diff

198 images did not require optimisation.

@robertjdominguez robertjdominguez enabled auto-merge (squash) November 15, 2024 13:42
@robertjdominguez robertjdominguez merged commit 00e0092 into main Nov 15, 2024
5 checks passed
@robertjdominguez robertjdominguez deleted the rahul/oct18/platformfeatures branch November 15, 2024 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants