techdocs icon indicating copy to clipboard operation
techdocs copied to clipboard

Create litmuschaos-analysis.md

Open dwelsch-esi opened this issue 1 year ago • 6 comments
trafficstars

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: https://github.com/cncf/techdocs/issues/218

dwelsch-esi avatar Aug 13 '24 22:08 dwelsch-esi

It's not strictly a techdocs analysis issue, but I did notice that a lot of their repos have a default branch master. We recommend main in most cases. https://inclusivenaming.org/word-lists/tier-1/_master/

I can look up the CNCF specific recommendation (i can't remember exactly where we make it).

nate-double-u avatar Aug 15 '24 21:08 nate-double-u

Looks like their main documentation site has the following stack:

  • host/build platform: Vercel (similar to Netlify)
  • Site generator: Docusaurus
  • theme: ?

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).

nate-double-u avatar Aug 15 '24 21:08 nate-double-u

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.

nate-double-u avatar Aug 15 '24 21:08 nate-double-u

(setting to draft to indicate that there are still sections to add and updates to make)

nate-double-u avatar Aug 15 '24 21:08 nate-double-u

It's not strictly a techdocs analysis issue, but I did notice that a lot of their repos have a default branch master. We recommend main in most cases. https://inclusivenaming.org/word-lists/tier-1/_master/

I can look up the CNCF specific recommendation (i can't remember exactly where we make it).

@dwelsch-esi, here's a good sample issue that @chalin opened for TUF: https://github.com/theupdateframework/theupdateframework.io/issues/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.

nate-double-u avatar Aug 15 '24 21:08 nate-double-u

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:

  • The domain is owned by LF, but the dns is delegated to AWS (it looks like, i'm not sure about this). Where does the DNS live, and who has access to it?
  • What's the website stack currently? It looks Like docusaurus hosted on Netlify but I want to confirm. If it is Netlify, who has access to it?

nate-double-u avatar Oct 08 '24 23:10 nate-double-u

Analytics appears to be with AWS Route 53. I'm looking to confirm access.

nate-double-u avatar Oct 18 '24 22:10 nate-double-u

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 avatar Oct 30 '24 23:10 nate-double-u

@nate-double-u, I still have to check in an Issues document, so can we wait and I'll add a README as well?

dwelsch-esi avatar Oct 30 '24 23:10 dwelsch-esi

Yup, happy to wait

nate-double-u avatar Oct 30 '24 23:10 nate-double-u

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.

nate-double-u avatar Dec 06 '24 20:12 nate-double-u