Skip to content

fix(agreements): fix the FAQ index links and move the 2016 SLA off the current page - #2633

Merged
marcus-souza-azion merged 3 commits into
mainfrom
fix/mm-16265-agreements-formatting
Nov 16, 2026
Merged

marcus-souza-azion merged 3 commits into
mainfrom
fix/mm-16265-agreements-formatting

Conversation

@bruno-andrade-azion

@bruno-andrade-azion bruno-andrade-azion commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor

What & why

Related issue: MM-16265, in the epic MM-16212
Pages affected: 10 files, in en and pt-br:

  • the Service Level Agreement: /en/documentation/agreements/sla/ and /pt-br/documentacao/contratos/sla/;
  • the Data Privacy FAQs index: /en/documentation/agreements/faqs/ and /pt-br/documentacao/contratos/faqs/;
  • the Azion Plans, Reserved Capacity, and Savings Plan terms and conditions.

This PR fixes formatting only. No legal wording changes. The items that need a wording change go to Legal, as the last item of this section says.

The 2016 SLA. The English SLA page published the current SLA (March 27, 2024) and then, after a ---, the whole SLA of May 25, 2016, with the same ## outline.

  • The table of contents listed "1. Service Level Guarantees" and every other section twice.
  • The 2016 version already has its own page, in the sidebar under Service Level Agreement.
  • The copy goes, and a ## Previous versions of this document section links the 2016 page, the way the current Terms of Service do.
  • The copy differed from the archived page in one word: it said "Firewall" where the archived page says "Edge Firewall". The archived page doesn't change.
  • pt-br never had the copy. It gets the same section, ## Versões anteriores deste documento, linking its 2016 page, and keeps the link to the registered PDF.

FAQ index.

  • The English page linked both FAQs without a trailing slash. Production answers those URLs with a 301 to the version with the slash, so every click took an extra redirect. Both links now end in /.
  • Both languages ended with a stray ---, which rendered as a horizontal rule, and no final newline.
  • The English description said the FAQs come "from our customers". It now says they are for customers and their end users.
  • Both languages had meta_tags: 'Serverless Applications, Documentations, FAQ'. They now describe data privacy.

Links in the terms and conditions.

  • Azion Plans and Reserved Capacity, in en and pt-br, linked the Customer Agreement and the Terms of Service with absolute https://www.azion.com/... URLs. They're root-relative now, so the link checker covers them.
  • The On Demand Price link to the marketing pricing page stays absolute. It isn't a docs page, and its URL is the visible link text.
  • The Savings Plan's Billing Metrics definition printed the Terms of Service URL in parentheses. It's a link now, as in the July 10, 2025 version.
  • Reserved Capacity loses an extra empty line before its first paragraph.

Left out on purpose.

  • The mailto in the English end-users FAQ shows [email protected] but sends to [email protected]. The English Privacy Policy has the same pairing, and no English page links mailto:privacy@, so I can't tell which address receives the requests. It stays as it is and goes to Legal.
  • The Savings Plan #### Previous versions of this document: heading. fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags #2629 already makes it an H2. The two PRs touch different lines and merge without conflict.
  • The descriptions of the Azion Plans, Reserved Capacity, and Savings Plan pages restate their titles and are shorter than 50 characters. That's outside this ticket.
  • The pt-br 2016 SLA page lives at /pt-br/documentacao/contratos/sla/25-marco-2016/, a March slug for a May document. The new pt-br section links it as it is. Fixing the slug needs a permalink change and a redirect, which this PR doesn't do.

For Legal, not edited here:

  • "Application Accelarator" in the English SLA;
  • the automatic-renewal wording in Savings Plan 3.2(c) and Reserved Capacity 1.2(b), in en and pt-br. Section 2.1 of neither document provides for automatic renewal; in the Savings Plan, it replaced the July 10, 2025 version's automatic-renewal clause;
  • "TLS 1.2 by default" in the customers FAQ and "end-to-end encryption" in the end-users FAQ;
  • which privacy mailbox receives requests;
  • the pt-br SLA service list, which lacks Cache and Tiered Cache;
  • the pt-br SLA PDF link, labelled "Contrato de Cliente".

They're listed in a comment on MM-16265.

How I checked it:

  • The docs writer gate (docs_gate.py --check) on the 10 files finds nothing new: 16 findings against 19 on main.
  • linkcheck.py finds 0 broken links and 0 cross-language links, and every namespace is paired en and pt-br.
  • pnpm lint:slugcheck lists the same 6 pt-br pages without an English pair as main (baseline 6). pnpm lint:navcheck passes. pnpm lint:links reports nothing on the changed files.
  • git merge-tree with fix(structure): tag bare code fences, fix heading skips, add pt-br meta_tags #2629, the only open PR that touches these files, shows no conflict.
  • pnpm ci:ratchet slugcheck passes at baseline 6. pnpm ci:ratchet linkcheck passes on the build, with 157 broken links against a baseline of 221. This PR fixes no broken link, so it doesn't account for the gap.
  • pnpm build:local passes with Node 26: 2,092 pages, plus the frontmatter test. In the built HTML:
    • the English SLA has one h2 per section, ending in #previous-versions-of-this-document, which links /en/documentation/agreements/sla/25-may-2016/;
    • the pt-br SLA ends in #versoes-anteriores-deste-documento, which links /pt-br/documentacao/contratos/sla/25-marco-2016/, and still links the registered PDF;
    • both FAQ indexes link the FAQs with a trailing slash, render no <hr>, and carry the new description and keywords;
    • the Azion Plans, Reserved Capacity, and Savings Plan pages link the Customer Agreement and the Terms of Service with root-relative URLs.
  • Not verified: I read the built HTML but didn't click through the pages in a browser.

Type of change

  • 🆕 New content (feat)
  • 🩹 Fix (fix) — typo, broken link, wrong information
  • ♻️ Content update (docs) — rewrite, expansion, upkeep
  • 🌐 Translation sync (i18n)
  • 🏗️ Platform / structure (refactor / chore) — reviewed by UXE, no content mixed in

Author checklist

  • PR title follows type(scope): summary (see GOVERNANCE.md §4)
  • Frontmatter complete: title, description, meta_tags, namespace, permalink, last_reviewed — no page in the repository carries last_reviewed, and the Azion Plans, Reserved Capacity, and Savings Plan descriptions still restate their titles, which is outside this ticket
  • No legacy "edge-" product names in the copy — the changed files have none, and this PR adds no copy
  • How-to/tutorial content includes at least one runnable, copy-paste-tested code block — no how-to or tutorial content is added or changed
  • Screenshots (if any) have alt text and follow image standards — no screenshot is added or changed
  • Internal links are relative and resolve locally — every docs link on the changed pages is root-relative and linkcheck.py resolves them; the pricing link stays absolute because it points to the marketing site
  • If any permalink changed or page moved: redirect added in this PR — no permalink changed and no page moved
  • i18n: pt-br updated in this PR or follow-up i18n issue created: — both languages are in this PR; the 2016 SLA copy and the FAQ links without a trailing slash existed only in English
  • I ran pnpm build:local (build + frontmatter check) without errors

…e current page

Formatting only. No legal wording changes.

- The English SLA repeated the whole May 25, 2016 SLA below the current
  one, which doubled every heading in the table of contents. The copy
  goes, and a "Previous versions of this document" section links the
  2016 page, as the current Terms of Service do. pt-br never had the
  copy; it gets the same section, next to the registered PDF link.
- The English data privacy FAQ index linked both FAQs without the
  trailing slash the site uses, so each click took a 301 redirect. Both
  languages drop a stray closing rule, and get a description and
  meta_tags about data privacy instead of Serverless Applications.
- Azion Plans and Reserved Capacity link the docs with absolute
  www.azion.com URLs; they become root-relative, so the link checker
  covers them. The Savings Plan Billing Metrics definition turns its bare
  URL into a link, as its July 10, 2025 version does.
…ts-formatting

* origin/main: (55 commits)
  docs(architectures): keep security-modernization and bot-management as API v3 versions (#2589)
  fix(runtime): clean up unused imports and JSDoc in the Node.js API samples (#2649)
  docs(platform): retire the v3 build and deploy journey pages (#2587)
  fix(compliance): correct the SOC report cadence and PCI DSS version (#2585)
  docs(runtime): fix the azion dev port and the function size limit (#2583)
  docs(console): apply the review of the Console path convention (#2644)
  docs(workloads): review the Workloads section with the style guide and correct it from live tests (#2570)
  fix(ai-inference): review the AI Inference section and correct it from live tests (#2641)
  docs(templates): apply the review of the migrated template guides (#2645)
  docs(templates): point Deploy links to the current Marketplace catalog (MM-16236) (#2582)
  docs(orchestrator): split how-tos into API v4 and API v3 pages (#2584)
  fix(accounts): hyphenate Real-Time Purge and name the Bills tab in the permissions table (#2581)
  chore(lint): accept the English-only Marketplace Agreement and lower the linkcheck baseline (#2647)
  fix(links): point the v3 Applications reference and the guides at the current pages (#2646)
  docs(runtime): migrate Node.js API samples to the ES Modules handler (MM-16245) (#2592)
  docs(observe): use the current GraphQL dataset names across Observe and guides (#2579)
  docs(templates): list the Astro templates that only the showcase covered (#2595)
  docs(orchestrator): consolidate duplicate guides and write How it works (#2588)
  docs(secure): retire the pre-Workloads security journey and guide pages (#2586)
  docs(applications): Run Function needs only Functions; fix WEBP and CORS prerequisites (#2580)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/agreements/faqs/faqs-index.mdx

@marcus-souza-azion marcus-souza-azion left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Revisei com foco no SLA, porque são contratos públicos. Nada aqui impede o merge. Ficam três observações:

1. O meta_tags do pt-br deve ficar em inglês (comentário na linha de pt-br/pages/contratos/faqs/faqs-index.mdx). A tabela de campos de frontmatter do style guide diz que esse campo fica em inglês na página pt-br: Bilingual pages. Nenhuma verificação valida o idioma do meta_tags, então nem o gate nem o CI pegam isso.

2. Confirme com o Jurídico a data de "última atualização". O cabeçalho do SLA em pt-br mostra Última atualização 13 de out. de 2026, mas o corpo do contrato diz Última atualização realizada em 27 de março de 2024. A data do cabeçalho vem do histórico do git do arquivo (lastUpdated em apps/docs/src/nav/index.ts), não do contrato. Quando esta PR entrar, o cabeçalho das duas páginas de SLA vai mostrar a data do merge, mesmo sem nenhuma mudança no texto do contrato. Você consegue verificar com o Jurídico qual data a página de um contrato público deve mostrar, e se a data do cabeçalho deve ser ocultada ou trocada nos contratos?

3. O título e a descrição não batem mais com o diff (não é crítico). Depois do merge da main, as barras finais dos links do FAQ já tinham entrado pelo #2646, e o #2629 foi mergeado em 12 de novembro. Então o diff não corrige mais os links do FAQ, e as notas sobre o #2629 e sobre a baseline do gate (16 contra 19) descrevem uma main antiga. Como o merge é squash, o título entra no histórico. Algo como fix(agreements): move the 2016 SLA off the current page and fix the agreements links and FAQ metadata descreveria o que entra.

O que conferi no SLA:

  • A cópia de 2016 removida do inglês difere da página arquivada /en/documentation/agreements/sla/25-may-2016/ em uma palavra só, "Firewall" contra "Edge Firewall", como a descrição diz. Comparei os dois textos com diff.
  • As novas seções "Previous versions of this document" e "Versões anteriores deste documento" seguem o padrão dos Termos de Serviço. Os dois links apontam para páginas que existem e estão registradas em agreements.json.
  • A branch está em dia com a main, e todos os checks do CI passam.

The style guide's bilingual frontmatter table leaves meta_tags in US
English on pt-br pages.
@marcus-souza-azion
marcus-souza-azion merged commit 3cbf585 into main Nov 16, 2026
9 checks passed
@marcus-souza-azion
marcus-souza-azion deleted the fix/mm-16265-agreements-formatting branch November 16, 2026 12:24
bruno-andrade-azion pushed a commit that referenced this pull request Nov 16, 2026
* origin/main: (71 commits)
  fix(opennext): migrate the OpenNext guide to the v4 azion.config.js format (#2651)
  chore(main): release docs 2.5.0 (#2638)
  docs(style-guide): settle closing names, sentence caps, and the date rule (#2630)
  chore(lint): accept the use-case closing in lint-links (#2632)
  feat(guides): add end-to-end tutorials for six products (#2652)
  fix(agreements): fix the FAQ index links and move the 2016 SLA off the current page (#2633)
  fix(functions): state that the Response Phase runs only Lua functions (#2650)
  docs(architectures): keep security-modernization and bot-management as API v3 versions (#2589)
  fix(runtime): clean up unused imports and JSDoc in the Node.js API samples (#2649)
  docs(platform): retire the v3 build and deploy journey pages (#2587)
  fix(compliance): correct the SOC report cadence and PCI DSS version (#2585)
  docs(runtime): fix the azion dev port and the function size limit (#2583)
  docs(console): apply the review of the Console path convention (#2644)
  docs(workloads): review the Workloads section with the style guide and correct it from live tests (#2570)
  fix(ai-inference): review the AI Inference section and correct it from live tests (#2641)
  docs(templates): apply the review of the migrated template guides (#2645)
  docs(templates): point Deploy links to the current Marketplace catalog (MM-16236) (#2582)
  docs(orchestrator): split how-tos into API v4 and API v3 pages (#2584)
  fix(accounts): hyphenate Real-Time Purge and name the Bills tab in the permissions table (#2581)
  chore(lint): accept the English-only Marketplace Agreement and lower the linkcheck baseline (#2647)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/angular-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/astro-blog-template.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/clean-astro-sanity.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/cosmic-agency-website.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/cosmic-simple-astro-blog.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/cosmicjs-simple-next-blog-template.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/devscard.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/docusaurus-javascript-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/docusaurus-typescript-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/dynamic-and-static-file-optimization.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/gatsby-blog-starter-kit.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/gatsby-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/htmx-minimal.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/hugo-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/jekyll-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/nextjs-static-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/nuxt-static-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/qstash-scheduler.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/qwik-minimal.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/react-book-store.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/static-cache.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/stencil-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/upstash-geolocation.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/upstash-rate-limiting.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/videoteca-static-cache.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/vite-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/vitepress-javascript-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/vitepress-typescript-boilerplate.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/webpage-to-pdf-resume.mdx
#	apps/docs/src/content/docs/en/pages/guides/marketplace/templates/wordpress-edgeaccelerator.mdx
#	apps/docs/src/content/docs/en/pages/main-menu/additional-resources/templates-and-integrations/understand-azion-templates.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/angular-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/astro-blog-template.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/clean-astro-sanity.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/cosmic-agency-website.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/cosmic-simple-astro-blog.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/cosmic-simple-next-blog.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/devscard.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/docusaurus-javascript-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/docusaurus-typescript-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/dynamic-and-static-file-optimization.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/gatsby-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/gatsby-starter-kit.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/htmx-minimal.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/hugo-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/jekyll-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/next-static-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/nuxt-static-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/qstash-scheduler.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/qwik-minimal.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/react-book-store.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/static-cache.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/stencil-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/upstash-geolocation.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/upstash-rate-limiting.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/videoteca-static-cache.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/vite-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/vitepress-javascript-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/vitepress-typescript-boilerplate.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/webpage-to-pdf-resume.mdx
#	apps/docs/src/content/docs/pt-br/pages/guias/marketplace/templates/wordpress-edgeaccelerator.mdx
#	apps/docs/src/content/docs/pt-br/pages/menu-principal/recursos-adicionais/templates-e-integracoes/templates-visao-geral.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 16, 2026
* origin/main: (67 commits)
  fix(opennext): migrate the OpenNext guide to the v4 azion.config.js format (#2651)
  chore(main): release docs 2.5.0 (#2638)
  docs(style-guide): settle closing names, sentence caps, and the date rule (#2630)
  chore(lint): accept the use-case closing in lint-links (#2632)
  feat(guides): add end-to-end tutorials for six products (#2652)
  fix(agreements): fix the FAQ index links and move the 2016 SLA off the current page (#2633)
  fix(functions): state that the Response Phase runs only Lua functions (#2650)
  docs(architectures): keep security-modernization and bot-management as API v3 versions (#2589)
  fix(runtime): clean up unused imports and JSDoc in the Node.js API samples (#2649)
  docs(platform): retire the v3 build and deploy journey pages (#2587)
  fix(compliance): correct the SOC report cadence and PCI DSS version (#2585)
  docs(runtime): fix the azion dev port and the function size limit (#2583)
  docs(console): apply the review of the Console path convention (#2644)
  docs(workloads): review the Workloads section with the style guide and correct it from live tests (#2570)
  fix(ai-inference): review the AI Inference section and correct it from live tests (#2641)
  docs(templates): apply the review of the migrated template guides (#2645)
  docs(templates): point Deploy links to the current Marketplace catalog (MM-16236) (#2582)
  docs(orchestrator): split how-tos into API v4 and API v3 pages (#2584)
  fix(accounts): hyphenate Real-Time Purge and name the Bills tab in the permissions table (#2581)
  chore(lint): accept the English-only Marketplace Agreement and lower the linkcheck baseline (#2647)
  ...

# Conflicts:
#	apps/docs/src/content/docs/en/pages/architectures/security-modernization/security-modernization-v3.mdx
#	apps/docs/src/content/docs/pt-br/pages/arquiteturas/security-modernization/security-modernization-v3.mdx
bruno-andrade-azion pushed a commit that referenced this pull request Nov 16, 2026
* origin/main: (66 commits)
  docs(templates): point the remaining Deploy links to the March 2026 catalog (#2599)
  fix(architectures): point Deploy buttons at the gallery template slugs (#2614)
  fix(opennext): migrate the OpenNext guide to the v4 azion.config.js format (#2651)
  chore(main): release docs 2.5.0 (#2638)
  docs(style-guide): settle closing names, sentence caps, and the date rule (#2630)
  chore(lint): accept the use-case closing in lint-links (#2632)
  feat(guides): add end-to-end tutorials for six products (#2652)
  fix(agreements): fix the FAQ index links and move the 2016 SLA off the current page (#2633)
  fix(functions): state that the Response Phase runs only Lua functions (#2650)
  docs(architectures): keep security-modernization and bot-management as API v3 versions (#2589)
  fix(runtime): clean up unused imports and JSDoc in the Node.js API samples (#2649)
  docs(platform): retire the v3 build and deploy journey pages (#2587)
  fix(compliance): correct the SOC report cadence and PCI DSS version (#2585)
  docs(runtime): fix the azion dev port and the function size limit (#2583)
  docs(console): apply the review of the Console path convention (#2644)
  docs(workloads): review the Workloads section with the style guide and correct it from live tests (#2570)
  fix(ai-inference): review the AI Inference section and correct it from live tests (#2641)
  docs(templates): apply the review of the migrated template guides (#2645)
  docs(templates): point Deploy links to the current Marketplace catalog (MM-16236) (#2582)
  docs(orchestrator): split how-tos into API v4 and API v3 pages (#2584)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants