Skip to content

Internal Technical & Security Portal

Welcome to the internal documentation platform for architecture references, troubleshooting runbooks, how-to guides, and cyber policies.

This site exists so that knowledge doesn't live in someone's head, a Slack thread, or a random shared drive. Every page here is version-controlled, reviewed, and easy to update — so when something changes, the docs change with it, and you can always see exactly what changed and when.

How this works

This platform is built on a docs-as-code approach — the same industry-standard methodology used by companies like Cloudflare, Stripe, and Kubernetes for their public documentation:

  • Markdown — pages are written in plain Markdown (CommonMark spec), so no special software is needed to contribute.
  • Git version control — every change is tracked, reviewed, and reversible through GitHub. Nothing is ever silently overwritten, and mistakes can always be rolled back.
  • Automated publishing — updates go live automatically once changes are merged. No manual deployment steps, no waiting on someone to "push a release."
  • Access-controlled — this site is restricted to internal users only, sitting behind Cloudflare Access. Content here never leaves GitHub or Cloudflare.

You don't need to know Git deeply to contribute — see below.

Getting Started

📘 New to Markdown?

Markdown is a simple, industry-standard way to format text using plain characters — no special software, no formatting menus, just readable plain text that renders nicely. It's the same format used by GitHub, Stripe, Slack, and most modern engineering documentation.

See the Markdown Guide for the basics — headings, lists, links, tables, and code blocks are really all you need for 90% of what goes here.

✏️ Want to add or update a document?

You don't need Git experience to contribute. See How to Submit or Update a Document below for a step-by-step walkthrough — including how to add images and diagrams.

📩 Questions, issues, or access requests?

Contact it@contoso.com. See Contact below for what to include in your request.

What's in here

Section What you'll find
Products Architecture overviews (with diagrams), troubleshooting runbooks, and general how-to wikis for each platform we run — Zscaler, Okta, CrowdStrike, Intune, and Corporate Email
Cyber Policies Official policy documents (PDF), indexed here for easy reference, opening in a new tab

How to navigate

  • Use the search bar at the top to jump straight to a page or keyword.
  • Use the left-hand navigation menu to browse by product or category.
  • Each page shows when it was last updated, so you always know how current the information is.

If you can't find what you're looking for, or think something's missing, reach out — see Contact.

How to Submit or Update a Document

You don't need to be a GitHub expert to contribute here. Pick the path that fits you.

Option 1 — Easiest: Edit directly on GitHub

  1. Open the page you want to change (or find the right folder for a new one) in the repository.
  2. Click the pencil (✏️) icon in the top right of the file to edit it, or use Add file → Create new file for a brand-new page.
  3. Make your changes in Markdown.
  4. Scroll down, add a short description of what you changed, and select "Create a new branch and start a pull request."
  5. Submit the pull request. Someone on the docs team will review and merge it — your changes go live automatically once merged.

This is the recommended path if you're not comfortable with Git — everything happens in the browser.

Option 2 — Using Git locally

If you're comfortable with Git:

  1. Clone the repository.
  2. Create a new branch: git checkout -b update-zscaler-runbook
  3. Make your changes.
  4. Commit and push: git commit -am "Update Zscaler runbook" then git push
  5. Open a pull request on GitHub for review.

Adding images or diagrams

  • Place the image file in the relevant products/<name>/ folder, alongside the Markdown file that uses it (drag-and-drop works directly in the GitHub web UI).
  • Reference it in your page like this: 
      ![Description of image](my-diagram.png)
  • Use descriptive filenames (zscaler-network-flow.png, not image1.png) — it makes the repo easier to maintain over time.

Where things go

Content type Folder
Architecture overview / diagrams products/<product>/index.md
Troubleshooting runbook products/<product>/runbooks/
General how-to / wiki products/<product>/how-tos/
Cyber policy (PDF) policies/files/, linked from policies/index.md

Not sure where something goes? Contact IT and we'll place it for you or point you to the right spot.

Guidelines

  • Keep page titles clear and specific (e.g. "Zscaler Connection Troubleshooting", not "Issues").
  • One topic per page where possible — easier to find, easier to keep current.
  • Don't paste sensitive credentials, API keys, or secrets into any document.
  • If you're updating an existing page rather than replacing it, keep the surrounding structure intact so reviewers can see exactly what changed.

Contact

For questions, access requests, or issues with this documentation site:

Email: it@contoso.com

Please include:

  • A link to the page you're referring to (if applicable)
  • A brief description of the issue or request
  • Screenshots, if relevant

What to contact us about

  • Content that's outdated, incorrect, or missing
  • Access issues (can't reach the site, permissions problems)
  • Help figuring out where a new document should go
  • General feedback on the platform

For urgent operational issues (production outages, security incidents), use the standard incident escalation process rather than this contact — this address is for documentation and access support.