Skip to content

OCC - Full Documentation Revamp#9368

Open
SlimJ4 wants to merge 44 commits into
developfrom
sa-occ-revamp-1
Open

OCC - Full Documentation Revamp#9368
SlimJ4 wants to merge 44 commits into
developfrom
sa-occ-revamp-1

Conversation

@SlimJ4
Copy link
Copy Markdown
Contributor

@SlimJ4 SlimJ4 commented May 6, 2026

What type of Pull Request is this?

  • New guide(s)
  • Deletion of guide(s)

Description

Complete restructuration of the OCC documentation, with new and more detailed guides.

Mandatory information

The translations in this Pull Request have been done using:

  • OVHcloud integrated translation LLM
  • Systran
  • Other tool : Claude
  • This Pull Request didn't require any translation.
  • This Pull Request can be merged as soon as possible.

SlimJ4 and others added 30 commits January 12, 2026 17:22
Initial FR version for the glossary. For now, still redundant with the OCC concepts overview guide.
added DC to the glossary, updated PoP.
New test version of the OVHcloud presentation guide.
Imported from SRenaud's branch. Adaptations made to respect current OVHcloud documentation guidelines.
Updated and formatted the PoP/Regions presentation guide
Combined all simple architectures guides into one with tabs for easier referencing.
WIP for Resilient.
thought I'd pushed that. Forgot to save the file on the first instance.
Recreated the L3 setup guides, corrected cross references across all other guides
Replaced API calls with f-strings in the Python scripts, so that the variables are correctly passed onto the API
Added VRRP sections in L3 guides
Removed inaccurate info about vRack networking and offloaded to the (WIP) vRack service presentation guide
- Corrected intro disclaimer
- Cleaned up requirements
- Removed Python SDK instructions
- Changed guides order (need confirmation for changes in quick start guides)
Reversed the order of "Associate with your vRack" and "Configure BGP", as the latter requires the former.
Removed the original folder for the PoP locations tables
Removed the Python code blocks from the L3 guides
- Removed L2 reference in Provider quick start guide
- Replaced "data centre" with "AZ" in L3 guides
SlimJ4 added 7 commits April 22, 2026 13:34
Added a section about the diagnostics in the 3.9 guide
Created the 3.12 Logs Forwarding guide (mostly reused the existing guide)
Removed some other L2 refs in provider guides.
Added the mention about OVHcloud not hosting routers for clients at PoPs
Corrected the 60-day rule for LOA
This commit uses the WIP expert-proofread function to check for language, clarity, consistency, and veracity.
Proofreading pass on the Single and Resilient architecture guides.
Large automated PR pass. See PR-REPORT.md for details
Added all fr-fr translations
Cleaned up all redundant files
added meta.yaml to all guide folders
@SlimJ4 SlimJ4 added the Offer: Network The PR documents Network products: Additional IP, BYOIP, Load Balancer, vRack, OCC, etc label May 6, 2026
@SlimJ4
Copy link
Copy Markdown
Contributor Author

SlimJ4 commented May 6, 2026

Missing index editions, fixing

@SlimJ4 SlimJ4 marked this pull request as ready for review May 6, 2026 10:37
@SlimJ4 SlimJ4 added Guide creation The Pull Request contains at least 1 new guide (meta.yaml and index edition needed) Guides removal This Pull Request contains removal of guides - 301 rules may be needed labels May 6, 2026
@SlimJ4
Copy link
Copy Markdown
Contributor Author

SlimJ4 commented May 6, 2026

Updating titles.

SlimJ4 and others added 2 commits May 6, 2026 12:59
Resolutions:
- .gitignore: take develop's superset (.claude/, cp-extraction, CLAUDE.md, CLAUDE.local.md, .mcp.json)
- pages/network/ovhcloud_connect/occ-diagnostics, occ-direct-control-panel, occ-provider-control-panel: confirm deletion (these legacy folders are replaced by the new numbered structure 1.1-5_faq; develop's CP-NAV template insertions from PR #9242 are not applicable to the new content)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

Screenshot Changes Detected

Image files (63)

File Status
pages/network/ovhcloud_connect/1.1_introduction_to_ovhcloud_connect/images/OCC_architecture_overview.png added
pages/network/ovhcloud_connect/occ-concepts-overview/images/VrackConnectDedicated2025.png removed
pages/network/ovhcloud_connect/occ-diagnostics/images/OCC_cpanel.png removed
pages/network/ovhcloud_connect/occ-diagnostics/images/OCC_diag_choice.png removed
pages/network/ovhcloud_connect/occ-diagnostics/images/OCC_diag_tab_BGP.png removed
pages/network/ovhcloud_connect/occ-diagnostics/images/OCC_diag_tab_MAC.png removed
pages/network/ovhcloud_connect/occ-diagnostics/images/OCC_diag_view_button.png removed
pages/network/ovhcloud_connect/occ-diagnostics/images/OCC_service_BGP.png removed
pages/network/ovhcloud_connect/occ-diagnostics/images/OCC_service_MAC.png removed
pages/network/ovhcloud_connect/occ-diagnostics/images/OCC_service_test_button_BGP.png removed
pages/network/ovhcloud_connect/occ-diagnostics/images/OCC_service_test_button_MAC.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/deletedc.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/deletepop.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/deleterouting.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l2dc1-1.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l2dc1-2.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l2dc1.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l2pop2.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l3dc0.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l3dc1-1.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l3dc1.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l3dc2.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l3dc3.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l3dc4.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l3dc5.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l3dc6.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l3pop1-1.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/l3pop2.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/occ_01.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/pop1.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/pop2.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/vrack01.png removed
pages/network/ovhcloud_connect/occ-direct-control-panel/images/vrack2.png removed
pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-implementation.png removed
pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-supported-unsupported.png removed
pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-topologies.png removed
pages/network/ovhcloud_connect/occ-layer2/images/occ-l2-trafic.png removed
pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-architecture.png removed
pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpasprepend-med.png removed
pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpglobal.png removed
pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-bgpvrack.png removed
pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-implementation.png removed
pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-mixl2.png removed
pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-multidc.png removed
pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-rules.gif removed
pages/network/ovhcloud_connect/occ-layer3/images/occ-l3-twopop.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/deletedc.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/deletepopl3.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/deleterouting.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/l3dc0.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/l3dc1-1.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/l3dc1.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/l3dc2.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/l3dc3.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/l3dc4.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/l3dc5.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/l3dc6.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/l3pop1-1.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/l3pop2.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/occ_01.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/pop1.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/vrack01.png removed
pages/network/ovhcloud_connect/occ-provider-control-panel/images/vrack2.png removed

Image link changes in guides (8 file(s))

pages/network/ovhcloud_connect/1.1_introduction_to_ovhcloud_connect/guide.en-gb.md

  • +![Global design](image.png)

pages/network/ovhcloud_connect/1.5_multi_az/guide.en-gb.md

  • +![Multi AZ architecture](image.png)

pages/network/ovhcloud_connect/occ-concepts-overview/guide.en-gb.md

  • -![OVHcloud Connect](images/VrackConnectDedicated2025.png){.thumbnail}

pages/network/ovhcloud_connect/occ-diagnostics/guide.en-gb.md

  • -![OCC Control Panel](images/OCC_cpanel.png){.thumbnail}
  • -![OCC Service](images/OCC_service_BGP.png){.thumbnail}
  • -![OCC Service Test Button](images/OCC_service_test_button_BGP.png){.thumbnail}
  • -![OCC Diagnostics Choice](images/OCC_diag_choice.png){.thumbnail}
  • -![OCC Diagnostics Tab](images/OCC_diag_tab_BGP.png){.thumbnail}
  • -![OCC Diagnostic view button](images/OCC_diag_view_button.png){.thumbnail}
  • -![OCC Control Panel](images/OCC_cpanel.png){.thumbnail}
  • -![OCC Service](images/OCC_service_MAC.png){.thumbnail}
  • -![OCC Service Test Button](images/OCC_service_test_button_MAC.png){.thumbnail}
  • -![OCC Diagnostics Tab](images/OCC_diag_tab_MAC.png){.thumbnail}
  • -![OCC Diagnostic view button](images/OCC_diag_view_button.png){.thumbnail}

pages/network/ovhcloud_connect/occ-direct-control-panel/guide.en-gb.md

  • -![ovhcloud connect selection](images/occ_01.png){.thumbnail}
  • -![vRack association](images/vrack01.png){.thumbnail}
  • -![vRack association](images/vrack2.png){.thumbnail}
  • -![adding PoP L2](images/pop2.png){.thumbnail}
  • -![adding PoP L2](images/l2pop2.png){.thumbnail}
  • -![adding PoP L3](images/pop1.png){.thumbnail}
  • -![adding PoP L3](images/l3pop1-1.png){.thumbnail}
  • -![ajout PoP](images/l3pop2.png){.thumbnail}
  • -![add AZ](images/l2dc1.png){.thumbnail}
  • -![add AZ](images/l2dc1-1.png){.thumbnail}
  • -![add AZ](images/l2dc1-2.png){.thumbnail}
  • -![add AZ](images/l3dc0.png){.thumbnail}
  • -![add AZ](images/l3dc1.png){.thumbnail}
  • -![add AZ](images/l3dc1-1.png){.thumbnail}
  • -![add routing configuration](images/l3dc2.png){.thumbnail}
  • -![add routing configuration](images/l3dc3.png){.thumbnail}
  • -![add routing configuration](images/l3dc5.png){.thumbnail}
  • -![add routing configuration](images/l3dc4.png){.thumbnail}
  • -![add routing configuration](images/l3dc6.png){.thumbnail}
  • -![deleting routing configuration](images/deleterouting.png){.thumbnail}
  • -![DC deletion](images/deletedc.png){.thumbnail}
  • -![deleting PoP configuration](images/deletepop.png){.thumbnail}

pages/network/ovhcloud_connect/occ-layer2/guide.en-gb.md

  • -![L2 Implementation](images/occ-l2-implementation.png){.thumbnail}
  • -![Supported and unsupported L2 Design](images/occ-l2-supported-unsupported.png){.thumbnail}
  • -![L2 Trafic](images/occ-l2-trafic.png){.thumbnail}
  • -![L2 Topologies](images/occ-l2-topologies.png){.thumbnail}

pages/network/ovhcloud_connect/occ-layer3/guide.en-gb.md

  • -![L3 Implementation](images/occ-l3-implementation.png){.thumbnail}
  • -![L3 Two POP](images/occ-l3-twopop.png){.thumbnail}
  • -![L3 Multi DC](images/occ-l3-multidc.png){.thumbnail}
  • -![L3 Rules](images/occ-l3-rules.gif){.thumbnail}
  • -![L3 Mix L2](images/occ-l3-mixl2.png){.thumbnail}
  • -![L3 Architecture](images/occ-l3-architecture.png){.thumbnail}
  • -![L3 BGP vRack](images/occ-l3-bgpvrack.png){.thumbnail}
  • -![L3 BGP Global Topology](images/occ-l3-bgpglobal.png){.thumbnail}
  • -![L3 BGP as-prepend](images/occ-l3-bgpasprepend-med.png){.thumbnail}

pages/network/ovhcloud_connect/occ-provider-control-panel/guide.en-gb.md

  • -![ovhcloud connect selection](images/occ_01.png){.thumbnail}
  • -![vRack association](images/vrack01.png){.thumbnail}
  • -![vRack association](images/vrack2.png){.thumbnail}
  • -![PoP addition](images/pop1.png){.thumbnail}
  • -![PoP addition](images/l3pop1-1.png){.thumbnail}
  • -![PoP addition](images/l3pop2.png){.thumbnail}
  • -![adding AZ](images/l3dc0.png){.thumbnail}
  • -![adding AZ](images/l3dc1.png){.thumbnail}
  • -![adding AZ](images/l3dc1-1.png){.thumbnail}
  • -![add AZ](images/l3dc2.png){.thumbnail}
  • -![add AZ](images/l3dc3.png){.thumbnail}
  • -![add AZ](images/l3dc5.png){.thumbnail}
  • -![add AZ](images/l3dc4.png){.thumbnail}
  • -![add AZ](images/l3dc6.png){.thumbnail}
  • -![deleting routing configuration](images/deleterouting.png){.thumbnail}
  • -![DC deletion](images/deletedc.png){.thumbnail}
  • -![deleting PoP configuration](images/deletepopl3.png){.thumbnail}

@SlimJ4
Copy link
Copy Markdown
Contributor Author

SlimJ4 commented May 6, 2026

Updating CP templates across all documents.

@Y0Coss
Copy link
Copy Markdown
Collaborator

Y0Coss commented May 6, 2026

Is there any chance we could still use the legacy full_slugs?
Deletion/re-creation of meta.yaml files (which contain the full_slugs) will mean dozens of redirections.
In the context of moving the whole documentation to the new platform and the related redirections plan, this change is not ideal.

@SlimJ4
Copy link
Copy Markdown
Contributor Author

SlimJ4 commented May 7, 2026

@Y0Coss Let me try to find the best overlap between the new version and the preexisting meta.yaml files. I don't guarantee a 100% correspondence since there are significant changes to the structure and entirely new guides, but I'll try to facilitate the migration to my best ability.

SlimJ4 added 2 commits May 13, 2026 14:54
Replaced a number of meta.yaml files with versions from the previous documentation structure.
Reworked full_slugs on non-legacy meta.yaml files to respect current formatting.
@SlimJ4
Copy link
Copy Markdown
Contributor Author

SlimJ4 commented May 13, 2026

@Y0Coss Replaced meta.yaml files with preexisting ones where there was a correspondence, and reworked full_slugs on other files to respect current formatting (I had missed "network-" at the beginning of the full_slugs).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Guide creation The Pull Request contains at least 1 new guide (meta.yaml and index edition needed) Guides removal This Pull Request contains removal of guides - 301 rules may be needed Offer: Network The PR documents Network products: Additional IP, BYOIP, Load Balancer, vRack, OCC, etc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants