Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create litmuschaos-analysis.md #275

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

dwelsch-esi
Copy link
Collaborator

@dwelsch-esi dwelsch-esi commented Aug 13, 2024

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

CNCF TechDocs analysis for LitmusChaos. Part of the process for moving to Graduated project maturity level.

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
Fixed MD formatting errors.

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
@nate-double-u
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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 nate-double-u marked this pull request as draft August 15, 2024 21:29
@nate-double-u
Copy link
Member

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

@nate-double-u nate-double-u added the Docs analysis CNCF technical documentation assistance label Aug 15, 2024
@nate-double-u
Copy link
Member

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

Removed references to unrelated commercial software site litmus.com APIs that I mistakenly thought were part of the Litmus Chaos project.

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

## Project documentation

LitmusChaos is a **graduated** project of CNCF. This means that the project

Choose a reason for hiding this comment

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

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)

Choose a reason for hiding this comment

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

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.

@nate-double-u
Copy link
Member

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?

Changed "graduated" to "incubating applying for graduated".

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
@nate-double-u nate-double-u marked this pull request as ready for review October 18, 2024 22:02
@nate-double-u
Copy link
Member

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

Signed-off-by: Nate W <natew@cncf.io>
Signed-off-by: Nate W <natew@cncf.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs analysis CNCF technical documentation assistance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CNCFSD-2191 LitmusChaos
4 participants