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

Rewrote installation instructions #316

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

dwelsch-esi
Copy link
Contributor

Removed redundant installation instructions. Rewrote instructions step by step
(though they're still a bit complicated). Moved explanation of hosted install to
its own page.

fixes #298

Reviewers: Please try all install scenarios to make sure the instructions are complete
and accurate.

Checklist:

  • Fixes #
  • Signed the commit for DCO to be passed
  • Labelled this PR & related issue with documentation tag

Copy link

vercel bot commented Jan 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
litmus-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 18, 2025 6:22pm

Copy link

netlify bot commented Jan 7, 2025

Deploy Preview for docs-litmuschaos ready!

Name Link
🔨 Latest commit d95a68d
🔍 Latest deploy log https://app.netlify.com/sites/docs-litmuschaos/deploys/678bf0112280230008c02088
😎 Deploy Preview https://deploy-preview-316--docs-litmuschaos.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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


<a href="https://harness.io/">Harness</a> offers a free service for community members which makes getting started with Litmus easy. Create an account to get started. Once logged in, create a new hosted control plane and connect to it via the up CLI. Litmus can be used as a hosted cloud service using <a href="https://app.harness.io/auth/#/signin">Harness Chaos Engineering SaaS</a>. Harness Chaos Engineering SaaS executes your Chaos Experiments in the cloud by managing all your Chaos Control Plane components, while the Chaos Execution Plane components exist on your Kubernetes cluster as part of an external chaos infrastructure.
<br/><br/>
To get started with Harness Chaos Engineering SaaS, visit <a href="https://developer.harness.io/docs/chaos-engineering/get-started/learn-more-free-plan">Harness Chaos Engineering SaaS</a> and register for free.
Copy link
Collaborator

Choose a reason for hiding this comment

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

It seems that the link https://developer.harness.io/docs/chaos-engineering/get-started/learn-more-free-plan results in a "Page Not Found" error. Can you resolve this error?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@suhyenim
/cc @nate-double-u

I recommend getting rid of this paragraph, for a couple reasons:

  • CNCF guidelines prohibit endorsing commercial sites in open source projects, and this is coming close to doing that;
  • Whatever external sites we link to should be stable, and this one has proved not to be;
  • Even another, similar offer (the closest I could find was https://www.harness.io/blog/get-started-with-harness-chaos-engineering-free-plan) is presumably time-limited and therefore, again, not a stable source of information.

Thoughts?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed last paragraph.

…inappropriately commercial.

Signed-off-by: Dave Welsch <[email protected]>
@suhyenim
Copy link
Collaborator

@dwelsch-esi
Could you explain why you modified the yarn.lock file?

@dwelsch-esi
Copy link
Contributor Author

@dwelsch-esi Could you explain why you modified the yarn.lock file?

@suhyenim I didn't -- not on purpose anyway. Must have accidentally checked in the automatically updated file in my local repo. How should I handle this? Revert back to pre-commit version?

@suhyenim
Copy link
Collaborator

@suhyenim I didn't -- not on purpose anyway. Must have accidentally checked in the automatically updated file in my local repo. How should I handle this? Revert back to pre-commit version?

@dwelsch-esi No worries! It's a common issue when working with yarn.lock or similar files. The best way to fix this would be to replace the yarn.lock file in your current branch with the version from the main branch.

@dwelsch-esi
Copy link
Contributor Author

@suhyenim I didn't -- not on purpose anyway. Must have accidentally checked in the automatically updated file in my local repo. How should I handle this? Revert back to pre-commit version?

@dwelsch-esi No worries! It's a common issue when working with yarn.lock or similar files. The best way to fix this would be to replace the yarn.lock file in your current branch with the version from the main branch.

@suhyenim Done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove duplicate install instructions
2 participants