Add Vitess analysis document by dwelsch-esi · Pull Request #284 · cncf/techdocs

dwelsch-esi · 2025-02-19T22:59:50Z

Resolves: #280

deepthi · 2025-02-23T19:22:53Z

+- Advanced > Distributed Atomic Transactions
+- Migration
+
+There is one special-purpose FAQ, for VReplication in the Reference.


We do have this FAQ as well
https://vitess.io/docs/faq/

Ah, OK. It's outside the versioned documentation so I missed it. There's a lot of good information here; I'll have a look and revise the analysis and recommendations!

@deepthi , @frouioui : I've updated the analysis to account fro the FAQ. Apologies for not catching the sections outside the versioned documentation. Please review.

deepthi · 2025-02-23T19:26:06Z

+**Localization & i18n directories**: Are you planning for localization/internationalization
+with regard to site directory structure?
+
+Yes, there are full versions of the documentation in both English and Chinese.


We have been debating removing the Chinese documentation because it is being simply copied over for each new release without any content updates.

@deepthi You mean you're copying a down-level version of the documentation without the updates for new releases? Which version of the documentation is the current Chinese version?

I would recommend keeping it, but maybe stop versioning it, or suggest it's archived or deprecated somehow.

I would recommend keeping it, but maybe stop versioning it, or suggest it's archived or deprecated somehow.

I'd recommend removing it from any release later than the last time it was updated, and redirect from the later releases to that version.

deepthi · 2025-02-23T19:32:57Z

+but it should be presented explicitly as a step in the procedure.
+
+Further down the page, another backup option, *Using mysqlshell*, has the same shortcomings:
+No actual command is presented.


The commands are presented towards the end of the page https://vitess.io/docs/21.0/user-guides/operating-vitess/backup-and-restore/creating-a-backup/
Maybe the page needs to be re-organized.

deepthi · 2025-02-23T19:34:24Z

+path for any problems with a task (the escalation path might be:
+*troubleshooting procedure > Slack Channel > project Issue*). Get rid of the
+[VReplication FAQ](https://vitess.io/docs/21.0/reference/vreplication/faq/)
+in the reference section and put the information in a troubleshooting section.


Would you recommend consolidating everything into https://vitess.io/docs/faq/
And potentially renaming that to Troubleshooting?

@deepthi That's one possibility but there's more than troubleshooting information in the FAQ. See comment above re the FAQ. Let me look into it and I'll add some options to the recommendations.

See recommendations in the analysis. The good news is that there's a lot of good information in the FAQ. The bad news is that it's outside your versioning regimen. Also, I'm not a fan of FAQs in general. I recommend folding the information into the regular technical documentation.

deepthi · 2025-02-23T19:36:35Z

+Yes, there is a Community link in the site’s menu bar, leading to the Community page.
+
+**New contributor document**: Is there a document specifically for new contributors/your
+first contribution?


https://vitess.io/docs/contributing/
That's for code contributions. Should we have a page for docs contributions?

@deepthi Yes, or add doc contribution instructions to the code contribution doc.

chalin · 2025-02-25T17:04:49Z

Rename this file to analyses/0014-vitess/analysis.md

@dwelsch-esi - please also rebase this PR from main at HEAD.

@dwelsch-esi - after you've rebased, also please ensure that all checks are passing.

I've done the rebase @dwelsch-esi & @chalin

(and the file rename)

Might be good to rebase again given the updates that have just landed for the link checking.

Also, could you address the GH check failures?

I just rebased again. I have to go do some mentorship stuff now, but I can check back in on this a bit later.

frouioui · 2025-02-26T14:21:04Z

+**Release process**: Does your code release process account for documentation creation
+& updates?
+
+No, neither the [Contribute](https://vitess.io/docs/contributing/) documentation nor
+the [CONTRIBUTING.md](https://github.com/vitessio/vitess/blob/main/CONTRIBUTING.md)
+file in the product repo describes how to contribute documentation. There is no Contribution
+section in the website repo.


We have this tool: https://github.com/vitessio/vitess-releaser, which maintainers use to create and ship new major and patch releases of Vitess. This tool lists and automated steps needed for a release, one of them is related to documentation and guides the maintainer on how to create and update the documentation before and after each release:

https://github.com/vitessio/vitess-releaser/blob/main/go/releaser/release/website_docs.go

@frouioui Does the tool verify that you've updated the release notes?

It does not do this automatically, there is only a step asking the release lead to review them.

What the tool does automate:

The creation of a changelog file that lists all Pull Requests that were merged for this release.

The creation final release notes file, which is a template containing the changelog + a summary file written and reviewed manually by maintainers. This file is later uploaded to the GitHub Release page by the tool.

chalin

See inline comments.

Also, I know that you're still working on this document, but consider addressing the check failures and then keeping the checks passing as the document evolves:

chalin · 2025-03-09T13:12:50Z

+> ````--topo_implementation=etcd2 --topo_global_server_address=<comma_separated_addresses>
+>   --topo_global_root=/vitess/global
+> ````


This markdown formatting doesn't make sense. First, you can use triple ticks. More importantly, there's probably a newline missing after the code-block opening syntax.

it's also a bit weird because it's a quote. I've gone in and fixed the newline tho.

Adding  as this is quoted content (if it's incorrectly formatted that needs to be communicated).

@dwelsch-esi, could you double check to make sure this snippet is correct from the source.

Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>

Signed-off-by: Nate W <natew@cncf.io>

…ubleshooting. Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Nate W <natew@cncf.io>

netlify · 2025-03-25T15:23:31Z

✅ Deploy Preview for cncf-techdocs ready!

Name	Link
🔨 Latest commit	`86fc5c9`
🔍 Latest deploy log	https://app.netlify.com/sites/cncf-techdocs/deploys/67e352ff6a1bfa0008aaa64c
😎 Deploy Preview	https://deploy-preview-284--cncf-techdocs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

… this analyis. Signed-off-by: Nate W <natew@cncf.io>

Signed-off-by: Nate W <natew@cncf.io>

nate-double-u

Let's merge this in as is. We've got issues getting opened over in https://github.com/vitessio/website/issues. We can make updates needed in a follow up PR.

nate-double-u · 2025-04-08T15:19:39Z

Thanks for this @dwelsch-esi, and thanks everyone for the reviews.

* Add Vitess analysis document. Signed-off-by: Dave Welsch <dwelsch@expertsupport.com> * renaming file Signed-off-by: Nate W <natew@cncf.io> * fixing formatting issues Signed-off-by: Nate W <natew@cncf.io> * fixing formatting issues Signed-off-by: Nate W <natew@cncf.io> * Update per review comments, including recommendations for FAQ and troubleshooting. Signed-off-by: Dave Welsch <dwelsch@expertsupport.com> * Update analyses/0014-vitess/analysis.md Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Nate W <natew@cncf.io> * Update analyses/0014-vitess/analysis.md Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Nate W <natew@cncf.io> * removing SEO, Analytics and local search sections as out of scope for this analyis. Signed-off-by: Nate W <natew@cncf.io> * updating spelling wordlist Signed-off-by: Nate W <natew@cncf.io> * fixing format Signed-off-by: Nate W <natew@cncf.io> * removing markdown disable no-bare-urls Signed-off-by: Nate W <natew@cncf.io> * updating codefence formatting Signed-off-by: Nate W <natew@cncf.io> * disabling fence-code-langage check on quoted content Signed-off-by: Nate W <natew@cncf.io> * fixing formatting Signed-off-by: Nate W <natew@cncf.io> --------- Signed-off-by: Dave Welsch <dwelsch@expertsupport.com> Signed-off-by: Nate W <natew@cncf.io> Co-authored-by: Nate W <natew@cncf.io> Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com>

@chalin

* updating domain and netlify information (#299) * updating domain and netlify information Signed-off-by: Nate W <natew@cncf.io> * Update docs/services.md Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Nate W <natew@cncf.io> --------- Signed-off-by: Nate W <natew@cncf.io> Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Add trademark guidance for Series LLCs to website guidelines (#298) * adding guidance for Series LLCs Signed-off-by: Nate W <natew@cncf.io> * Update docs/website-guidelines-checklist.md Signed-off-by: Nate W <natew@cncf.io> * Update docs/website-guidelines-checklist.md Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Nate W <natew@cncf.io> * updating formatting after applying edit Signed-off-by: Nate W <natew@cncf.io> --------- Signed-off-by: Nate W <natew@cncf.io> Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Use slack.cncf.io as canonical URL (#300) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Docusaurus version of docs pages (#301) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Adjust markdown syntax of analyses pages (#302) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update README.md Updating Nate W.'s role. Signed-off-by: Nate W <natew@cncf.io> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Fix licenses (#305) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Add links to licenses to README and site footer (#306) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Fix production URL (#308) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Revise README, update PC role, add links (#309) * Revise README, update PC role, add links Signed-off-by: Patrice Chalin <pchalin@gmail.com> * Nate's feedback Signed-off-by: Patrice Chalin <pchalin@gmail.com> --------- Signed-off-by: Patrice Chalin <pchalin@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * [CI] Use htmltest for link checking (#310) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Add Vitess analysis document (#284) * Add Vitess analysis document. Signed-off-by: Dave Welsch <dwelsch@expertsupport.com> * renaming file Signed-off-by: Nate W <natew@cncf.io> * fixing formatting issues Signed-off-by: Nate W <natew@cncf.io> * fixing formatting issues Signed-off-by: Nate W <natew@cncf.io> * Update per review comments, including recommendations for FAQ and troubleshooting. Signed-off-by: Dave Welsch <dwelsch@expertsupport.com> * Update analyses/0014-vitess/analysis.md Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Nate W <natew@cncf.io> * Update analyses/0014-vitess/analysis.md Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Nate W <natew@cncf.io> * removing SEO, Analytics and local search sections as out of scope for this analyis. Signed-off-by: Nate W <natew@cncf.io> * updating spelling wordlist Signed-off-by: Nate W <natew@cncf.io> * fixing format Signed-off-by: Nate W <natew@cncf.io> * removing markdown disable no-bare-urls Signed-off-by: Nate W <natew@cncf.io> * updating codefence formatting Signed-off-by: Nate W <natew@cncf.io> * disabling fence-code-langage check on quoted content Signed-off-by: Nate W <natew@cncf.io> * fixing formatting Signed-off-by: Nate W <natew@cncf.io> --------- Signed-off-by: Dave Welsch <dwelsch@expertsupport.com> Signed-off-by: Nate W <natew@cncf.io> Co-authored-by: Nate W <natew@cncf.io> Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Analytics docs rework: factor out UA-to-GA4 instructions, and more (#312) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * adding Daniel to staff list (#316) * adding Daniel to staff list Signed-off-by: Nate W <natew@cncf.io> * formatting and spelling Signed-off-by: Nate W <natew@cncf.io> --------- Signed-off-by: Nate W <natew@cncf.io> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * removing mention of alphabetizing the staff list Signed-off-by: Nate W <natew@cncf.io> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update refcache: Add Daniel's GH handle (#319) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * [CI] Update packages (#321) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * [docs] Use canonical path in link (#322) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Rename {analyses,docs}/**/README.md to index.md (#323) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Fix page title, adjust link-check scripts (#324) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Link, title, and filename adjustments (#325) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Canonicalize README links, cleanup package.json (#326) Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Add Knative TechDoc analysis and issues list. (#329) Signed-off-by: Dave Welsch <dwelsch@expertsupport.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: fix CI errors Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: prettify docs Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * [CI] Update packages and revert mdl-disable directives Signed-off-by: Patrice Chalin <pchalin@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Add Helm tech doc analysis Signed-off-by: Paige Calvert <eura.calvert@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Edit links and add issues list doc Signed-off-by: Paige Calvert <eura.calvert@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * update proposed sidebar & typo and md formatting fixes Signed-off-by: Paige Calvert <eura.calvert@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * remove unedited issues list file Signed-off-by: Paige Calvert <eura.calvert@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * run prettier on helm analysis and implementation Signed-off-by: Paige Calvert <eura.calvert@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Add helm issues list Signed-off-by: Paige Calvert <eura.calvert@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Fix linter and spell errors Signed-off-by: Paige Calvert <eura.calvert@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * shorten headings Signed-off-by: Paige Calvert <eura.calvert@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * adding ops/servicedesk label (#336) Signed-off-by: Nate W <natew@cncf.io> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Chore: Drop numbered analysis folders and adopt a date format instead (#337) * chore: drop numbered analysis folders and adopt a date format instead Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: prettify docs Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: update check-md script Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: nit fix Signed-off-by: thisisobate <obasiuche62@gmail.com> --------- Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Added template and started customizing Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * File fix - added analysis.md Also restored mistakenly used template Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Formatting fixes Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Initial write-up of analysis Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Spelling fixes Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update index.md Removed dead link Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update ua-to-ga4.md Removed dead link Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: Add a GH workflow to trigger contribute site Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: prettify code Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: move info from top level README to docs readme Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: fix CI errors Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: update all analyses to use correct docusaurus tags system (#340) * chore: update all analyses to use correct docusaurus tags system Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: CI fix Signed-off-by: thisisobate <obasiuche62@gmail.com> --------- Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: fix MDX related errors for vitess and knative analyses (#341) Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: nit fix Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: nit fix Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Chore: Fix all broken links outlined in issue description (#345) * Chore: Fix all broken links outlined in issue description Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: format files Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error again Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix link checker in CI Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: add backsticks to link Signed-off-by: thisisobate <obasiuche62@gmail.com> --------- Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Removed incomplete links The source for "Adding Analytics" is no longer available, removed links. Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Removed possible formatting build problems Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Formatting Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Formatting Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Temporarily removed last sections to isolate formatting issue Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md More formatting tests Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: move info from top level README to docs readme Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: fix CI errors Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: nit fix Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: nit fix Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Chore: Fix all broken links outlined in issue description (#345) * Chore: Fix all broken links outlined in issue description Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: format files Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error again Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix link checker in CI Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: add backsticks to link Signed-off-by: thisisobate <obasiuche62@gmail.com> --------- Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * misc edits Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * adding ops/servicedesk label (#336) Signed-off-by: Nate W <natew@cncf.io> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Chore: Drop numbered analysis folders and adopt a date format instead (#337) * chore: drop numbered analysis folders and adopt a date format instead Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: prettify docs Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: update check-md script Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: nit fix Signed-off-by: thisisobate <obasiuche62@gmail.com> --------- Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Added template and started customizing Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> * File fix - added analysis.md Also restored mistakenly used template Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Formatting fixes Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Initial write-up of analysis Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: move info from top level README to docs readme Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: fix CI errors Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: nit fix Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: nit fix Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Chore: Fix all broken links outlined in issue description (#345) * Chore: Fix all broken links outlined in issue description Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: format files Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error again Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix link checker in CI Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: add backsticks to link Signed-off-by: thisisobate <obasiuche62@gmail.com> --------- Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Removed possible formatting build problems Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Formatting Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Formatting Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md Temporarily removed last sections to isolate formatting issue Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analysis.md More formatting tests Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: move info from top level README to docs readme Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: fix CI errors Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: nit fix Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * chore: nit fix Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Chore: Fix all broken links outlined in issue description (#345) * Chore: Fix all broken links outlined in issue description Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: format files Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix markdown error again Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: fix link checker in CI Signed-off-by: thisisobate <obasiuche62@gmail.com> * chore: add backsticks to link Signed-off-by: thisisobate <obasiuche62@gmail.com> --------- Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Used Prittier extension Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * link edits Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * minor edit to rebuild Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * spelling fix Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * edit to rebuild Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Link edits Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update Docsy feedback links, htmltest & refcache (#347) Reduce htmltest CacheExpires to ~6 months, update docsy analytics link paths in analytics docs to /docs/content/feedback/#adding-analytics, and refresh static/refcache.json (LastSeen timestamps, some status codes, and a new GitHub ref entry). These changes keep link references current and shorten cache expiry for HTML tests. Signed-off-by: Patrice Chalin Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Formatting fixes to build Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Minimal formatting fixes Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Ran VS Code Prittier extension on index.md Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * minimal format fixes to index.md Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Restore docs/analytics/index.md from upstream/main Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Apply suggestion from @chalin Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Nate W <natew@cncf.io> * put back remaining part of template Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Fixed prittier hits Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Prittier VS Code ext - Format Document test Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Update analyses/2026/flatcar/analysis.md Co-authored-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com> Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com> * Update analyses/2026/flatcar/analysis.md Co-authored-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com> Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com> * Update analyses/2026/flatcar/analysis.md Co-authored-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com> Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com> * worked on the Recommendataions section Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * more writing Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * prittier extension test Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * misc updates Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * Initial write of proj doc reccomendations Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * general edits Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> * spelling fix Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> --------- Signed-off-by: Nate W <natew@cncf.io> Signed-off-by: Bruce Hamilton <bhamilton@expertsupport.com> Signed-off-by: Patrice Chalin <pchalin@gmail.com> Signed-off-by: Dave Welsch <dwelsch@expertsupport.com> Signed-off-by: thisisobate <obasiuche62@gmail.com> Signed-off-by: Paige Calvert <eura.calvert@gmail.com> Signed-off-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Signed-off-by: Patrice Chalin Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com> Co-authored-by: Nate W <natew@cncf.io> Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Co-authored-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com> Co-authored-by: thisisobate <obasiuche62@gmail.com> Co-authored-by: Patrice Chalin <pchalin@gmail.com> Co-authored-by: Paige Calvert <eura.calvert@gmail.com> Co-authored-by: Bruce Hamilton <12780597+iRaindrop@users.noreply.github.com> Co-authored-by: Bruce Hamilton <bhamilton@expertsupport.com>

nate-double-u mentioned this pull request Feb 21, 2025

Update doc analysis criteria #286

Merged

deepthi reviewed Feb 23, 2025

View reviewed changes

chalin requested changes Feb 25, 2025

View reviewed changes

frouioui reviewed Feb 26, 2025

View reviewed changes

chalin changed the title ~~Add Vitess analysis document.~~ Add Vitess analysis document Mar 9, 2025

chalin requested changes Mar 9, 2025

View reviewed changes

dwelsch-esi and others added 8 commits March 17, 2025 14:03

Add Vitess analysis document.

ce9648d

Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>

renaming file

0bab389

Signed-off-by: Nate W <natew@cncf.io>

fixing formatting issues

7d011d1

Signed-off-by: Nate W <natew@cncf.io>

fixing formatting issues

a2b1ead

Signed-off-by: Nate W <natew@cncf.io>

Update per review comments, including recommendations for FAQ and tro…

763d282

…ubleshooting. Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>

Update analyses/0014-vitess/analysis.md

9b0d752

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Nate W <natew@cncf.io>

Update analyses/0014-vitess/analysis.md

3748196

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com> Signed-off-by: Nate W <natew@cncf.io>

Merge branch 'main' into main

71e7e2b

nate-double-u added 7 commits March 25, 2025 17:35

removing SEO, Analytics and local search sections as out of scope for…

dc83ade

… this analyis. Signed-off-by: Nate W <natew@cncf.io>

updating spelling wordlist

bf10dc6

Signed-off-by: Nate W <natew@cncf.io>

fixing format

c899886

Signed-off-by: Nate W <natew@cncf.io>

removing markdown disable no-bare-urls

6bc4fa6

Signed-off-by: Nate W <natew@cncf.io>

updating codefence formatting

74d8787

Signed-off-by: Nate W <natew@cncf.io>

disabling fence-code-langage check on quoted content

94dc35b

Signed-off-by: Nate W <natew@cncf.io>

fixing formatting

86fc5c9

Signed-off-by: Nate W <natew@cncf.io>

nate-double-u requested a review from chalin March 26, 2025 01:08

nate-double-u approved these changes Apr 8, 2025

View reviewed changes

nate-double-u enabled auto-merge (squash) April 8, 2025 15:19

nate-double-u disabled auto-merge April 8, 2025 15:21

nate-double-u merged commit 77d8246 into cncf:main Apr 8, 2025
9 checks passed

Conversation

dwelsch-esi commented Feb 19, 2025 • edited by nate-double-u Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chalin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

netlify Bot commented Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for cncf-techdocs ready!

Uh oh!

nate-double-u left a comment

Choose a reason for hiding this comment

Uh oh!

nate-double-u commented Apr 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

dwelsch-esi commented Feb 19, 2025 •

edited by nate-double-u

Loading

netlify Bot commented Mar 25, 2025 •

edited

Loading