Add Vitess analysis document. #284
Conversation
Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>
| - Advanced > Distributed Atomic Transactions | ||
| - Migration | ||
|
|
||
| There is one special-purpose FAQ, for VReplication in the Reference. |
There was a problem hiding this comment.
We do have this FAQ as well
https://vitess.io/docs/faq/
There was a problem hiding this comment.
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!
| **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. |
There was a problem hiding this comment.
We have been debating removing the Chinese documentation because it is being simply copied over for each new release without any content updates.
There was a problem hiding this comment.
@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?
There was a problem hiding this comment.
I would recommend keeping it, but maybe stop versioning it, or suggest it's archived or deprecated somehow.
| 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. |
There was a problem hiding this comment.
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.
| 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. |
There was a problem hiding this comment.
Would you recommend consolidating everything into https://vitess.io/docs/faq/
And potentially renaming that to Troubleshooting?
There was a problem hiding this comment.
@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.
| 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? |
There was a problem hiding this comment.
https://vitess.io/docs/contributing/
That's for code contributions. Should we have a page for docs contributions?
There was a problem hiding this comment.
@deepthi Yes, or add doc contribution instructions to the code contribution doc.
There was a problem hiding this comment.
Rename this file to analyses/0014-vitess/analysis.md
There was a problem hiding this comment.
@dwelsch-esi - please also rebase this PR from main at HEAD.
There was a problem hiding this comment.
@dwelsch-esi - after you've rebased, also please ensure that all checks are passing.
There was a problem hiding this comment.
I've done the rebase @dwelsch-esi & @chalin
There was a problem hiding this comment.
Might be good to rebase again given the updates that have just landed for the link checking.
There was a problem hiding this comment.
Also, could you address the GH check failures?
There was a problem hiding this comment.
I just rebased again. I have to go do some mentorship stuff now, but I can check back in on this a bit later.
Signed-off-by: Nate W <natew@cncf.io>
Resolves: #280