Skip to content

Conversation

@Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented Dec 11, 2024

Summary

Currently, in the Reference Architecture in dev docs, there are 3 types of Overview pages.

  1. The main Overview page. This is fine as it is, and has not been modified.
  2. Overview pages which purely contain links to the items available on the sidebar. These have been hidden.
  3. Overview pages which has links + explanation. These have also been hidden. The existing text did not really provide much meaningful information beyond the "Overview" and "How to use" pages.

Note that the hidden pages still exist. For example, currently, the links in the "How to use" page directs users to the hidden "Overview" pages. We can further update the links to land on a different page.

If these Overview pages are really important, we should consider adding more meaningful information.

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Dec 11, 2024

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 51f3a9c
Status: ✅  Deploy successful!
Preview URL: https://4d66e9a1.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev

View logs

@github-actions
Copy link
Contributor

github-actions bot commented Dec 11, 2024

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/reference-architecture/implementation-guides/application-security/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/implementation-guides/application-security/
https://developers.cloudflare.com/reference-architecture/implementation-guides/zero-trust/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/implementation-guides/zero-trust/
https://developers.cloudflare.com/reference-architecture/architectures/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/architectures/
https://developers.cloudflare.com/reference-architecture/design-guides/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/design-guides/
https://developers.cloudflare.com/reference-architecture/diagrams/ai/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/diagrams/ai/
https://developers.cloudflare.com/reference-architecture/diagrams/bots/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/diagrams/bots/
https://developers.cloudflare.com/reference-architecture/diagrams/content-delivery/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/diagrams/content-delivery/
https://developers.cloudflare.com/reference-architecture/diagrams/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/diagrams/
https://developers.cloudflare.com/reference-architecture/diagrams/iot/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/diagrams/iot/
https://developers.cloudflare.com/reference-architecture/diagrams/network/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/diagrams/network/
https://developers.cloudflare.com/reference-architecture/diagrams/sase/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/diagrams/sase/
https://developers.cloudflare.com/reference-architecture/diagrams/security/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/diagrams/security/
https://developers.cloudflare.com/reference-architecture/diagrams/serverless/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/diagrams/serverless/
https://developers.cloudflare.com/reference-architecture/diagrams/storage/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/diagrams/storage/
https://developers.cloudflare.com/reference-architecture/implementation-guides/ https://jun-ref-architecture-overvie.cloudflare-docs-7ou.pages.dev/reference-architecture/implementation-guides/

@Oxyjun Oxyjun self-assigned this Dec 11, 2024
Copy link
Contributor

@securitypedant securitypedant left a comment

Choose a reason for hiding this comment

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

Great improvement.

@Oxyjun Oxyjun merged commit d37d2e5 into production Dec 12, 2024
12 checks passed
@Oxyjun Oxyjun deleted the jun/ref-architecture/overview-cleanup branch December 12, 2024 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants