LitmusChaos TechDocs Analysis #275
Conversation
|
It's not strictly a techdocs analysis issue, but I did notice that a lot of their repos have a default branch I can look up the CNCF specific recommendation (i can't remember exactly where we make it). |
|
Looks like their main documentation site has the following stack:
They don't appear to have a Google Analytics analytics account (at least not with CNCF), but i expect Vercel may have some analytics capabilities (like Netlify does). |
|
We'll need to chat with the team about their Vercel account. I'm not sure who is funding it, and I'd like to know more about how they're using it before making a recommendation to shift to Netlify, but Netlify may save us all some money. |
|
(setting to draft to indicate that there are still sections to add and updates to make) |
@dwelsch-esi, here's a good sample issue that @chalin opened for TUF: theupdateframework/theupdateframework.io#64. We should add this to the issues templates in the analysis guide. If you'd like, you can open the issue. Additionally, you can volunteer me to do the update like @chalin volunteered himself (though I'd need to be given permissions), or I can create the issue. |
|
|
||
| ## Project documentation | ||
|
|
||
| LitmusChaos is a **graduated** project of CNCF. This means that the project |
There was a problem hiding this comment.
LitmusChaos is currently in an incubation state so that we can update this.
| - Formatting and organization of the instructions is inconsistent. | ||
| - Some minor functionality does not have complete step-by-step instructions. | ||
| For example, a link in the instructions to connect an external delegate in | ||
| [Schedule a chaos scenario](https://v2-docs.litmuschaos.io/docs/user-guides/schedule-workflow) |
There was a problem hiding this comment.
This seems to be an older website reference from the period where LitmusChaos v2 had recently been released and v1 was also very much in use. Hence, the content here isn't updated. This page has been updated since and we'll remove this along with any other unused sites.
|
I don't see any analytics in the CNCF google analytics account. Thanks for following up @neelanjan00, I also still have some questions about the hosting and DNS:
|
|
Analytics appears to be with AWS Route 53. I'm looking to confirm access. |
nate-double-u
force-pushed
the
litmuschaos-analysis
branch
from
66accbb to
31c9d1e
Compare
nate-double-u
changed the title
|
Format check looks broken, and the failed links aren't a part of this PR so I'll set this to passing. @dwelsch-esi, I've squashed all the commits, do you want me to merge as is, or do you want to do up a README.md file for this? |
|
@nate-double-u, I still have to check in an Issues document, so can we wait and I'll add a README as well? |
|
Yup, happy to wait |
nate-double-u
force-pushed
the
litmuschaos-analysis
branch
from
bd4a1d2 to
f034a0e
Compare
- CNCF TechDocs analysis for LitmusChaos. Part of the process for moving to Graduated project maturity level. Create litmuschaos-implementation.md - Breakdown of recommendations from litmuschaos-analysis.md. Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
nate-double-u
force-pushed
the
litmuschaos-analysis
branch
from
c0edd9f to
b9c2c39
Compare
|
The format check works locally, and the link checker seems kinda broken. I'll merge this in as is, and we can open a follow up issue to deal with the formatting checks. |
CNCF TechDocs analysis for LitmusChaos. Part of the process for moving to Graduated project maturity level.
@nate-double-u Please review and perform or delegate SEO analysis.
resolves: #218