Code Monkey home page Code Monkey logo

website's Introduction

Chaos Mesh Logo Chaos Mesh Logo

Website

Built using Docusaurus 3, a modern static website generator.

Contribute with Gitpod

How to develop

pnpm i # install deps
pnpm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

By default, the start command will only preview documents in English. If you want to preview documents in other languages, such as Chinese, then add --locale after the command:

pnpm start --locale zh

Build

pnpm build

This command generates static content into the build directory and can be served using any static contents hosting service.

Release a new version

Major or minor

pnpm docusaurus docs:version x.x.x

The versions of the all docs split into two parts, one is the latest (in docs/) and the others are versioned (in versioned_docs/). When a version has been released, the current latest docs/ will be copied into versioned_docs/ (by running the command above).

i18n

All translated docs won't be copied automatically. You have to handle them manually. For example, release 2.2.0:

  1. Copy i18n/zh/docusaurus-plugin-content-docs/current.json to the same folder and rename it to i18n/zh/docusaurus-plugin-content-docs/version-2.2.0.json.

  2. The replace Next and current in version-2.2.0.json, e.g.:

    "version.label": {
  "message": "Next",
  "description": "The label for version current"
}

    to:

     "version.label": {
   "message": "2.2.0",
   "description": "The label for version 2.2.0"
 }

Don't forget test the new version build after you've done the above steps!

Patch

For patch versions, it's only needed to move some folders and change some text. For example, v2.1.3 to v2.1.4:

  1. Replace 2.1.3 in versions.json with 2.1.4.
  2. versioned_docs/version-2.1.3 to versioned_docs/version-2.1.4.
  3. versioned_sidebars/version-2.1.3-sidebars.json to versioned_sidebars/version-2.1.4-sidebars.json and replace 2.1.3 with 2.1.4 (if have) in json.
  4. i18n/zh/docusaurus-plugin-content-docs/version-2.1.3 to i18n/zh/docusaurus-plugin-content-docs/version-2.1.4.
  5. i18n/zh/docusaurus-plugin-content-docs/version-2.1.3.json to i18n/zh/docusaurus-plugin-content-docs/version-2.1.4.json and replace 2.1.3 with 2.1.4 in json.
  6. Update src/data/versions.js.

Don't forget test the new version build after you've done the above steps!

How to contribute

Mostly you only need to modify the content in the docs/, but if you want some versions to take effect as the latest, please also update the same files in the versioned_docs/ dir.

License

Distributed under CC-BY-4.0.

website's People

Contributors

agilob avatar andrewmatilde avatar anotherrachel avatar anuragpaliwal80 avatar arodindev avatar bellaxiang avatar colstuwjx avatar cwen0 avatar dependabot[bot] avatar en-jin19 avatar erekgit avatar fewdan avatar fingerleader avatar g1eny0ung avatar hexilee avatar iguoyr avatar liuxiaozhen12 avatar ma3cin avatar milasuperstar avatar nioshield avatar oreoxmt avatar radupopa2010 avatar strrl avatar tsthght avatar wangxiangustc avatar xlgao-zju avatar yangkeao avatar yiyiyimu avatar yusitong1999 avatar zhouqiang-cl avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar avatar avatar avatar

Forkers

manishdangi98 cwen0 radupopa2010 yiyiyimu huanli-meng hedfi-hamza strrl qinjin bellaxiang yangkeao gallardot milasuperstar caitinchen haoqing0110 gesaint adamdmharvey hangyan debanitrkl anuragpaliwal80 erekgit zeo1995 joyinqin qiancai liuxiaozhen12 saravanan30erd charlotteiu ran-huang asternight aaron-23 himanshumohan19 en-jin19 agilob hexilee iguoyr anotherrachel oro wangxiangustc dsouzajaison gabrielcc hfxsd kaitoii11 damonlin1992 mingleiw andrewmatilde ericsyh airjacky seriousgong jinqueeny tanglizigit fewdan ohareza fingerleader hiiirad yantingsong etigerstudio liuyunbiao2021 isabella232 xlgao-zju songrgg crazycloud1024 brainhorse nioshield mrrotski inetkiller fnikolai randylambert shenzp1993 marcoma2018 brnck gushev rindrics chenjiaxingxjtu sevenleave mandsss sh9901 daydayupyjw enthurohini avn-confluent jamemamjame cugykw bumarcell atrbear davidcollom wuhuizuo punarjitsingh-okta arodindev riflowth wenyxu yusitong1999 cycwll munsirameen caorong vrepsys jonashenkel moqimoqidea heart-hellomark microdao-bio ibalajiarun happy-v587 rithythul

website's Issues

Broken links for Vector Wasm Transformer

website/blog/2021-06-25-chaos-mesh-remake-one-step-closer-toward-chaos-as-a-service.md

Line 137 in 2d24e56

- Use WebAssembly (Wasm). When you need to call chaos experiment logic, just call the Wasm program. See Vector's [WASM Transform](https://webcache.googleusercontent.com/search?q=cache:aR1ZIlTwz9sJ:https://vector.dev/docs/reference/configuration/transforms/wasm/+&cd=2&hl=zh-CN&ct=clnk&gl=jp).

I saw that here is an update in #286. But it still failed with 404

Maybe incorrect "Usage restrictions" for PodChaos

I noticed that there is a description of PodChaos:

Currently, Chaos Mesh only supports fault injection to certain types of Pod, such as Deployment, StatefulSet, and DaemonSet. Chaos Mesh does not support injecting faults into an independent Pod. An independent Pod means a Pod that is not bound to ReplicaSet or Deployment Pod.

https://github.com/chaos-mesh/website/blame/master/docs/simulate-pod-chaos-on-kubernetes.md#L17

I think Chaos Mesh could inject PodChaos into "independent Pod", but there is no guarantee for the "application/system" could recover to normal, because there is no upper layer controller to reconcile pods to "desired state"

I think the description needs updates.

FYI @g1eny0ung @YangKeao

Update offline installation

In the document "offline installation", we would use the helm chart from the master branch.

Actually, we should use the helm chart with that certain release version.

After this PR chaos-mesh/chaos-mesh#3293 merged ( would be released in 2.3.0), we would not use helm chart from the chaos-mesh/chaos-mesh repo. We should use the content from https://github.com/chaos-mesh/charts/tree/gh-pages

refer:

More detailed description about "Duration"

Each type of Chaos contains an optional field "duration". It introduces how long time a chaos experiment would affect.

A notable detail is the "duration" is calculated from the chaos experiment "created", not "applied".

The reason is Chaos Mesh prefers to use a determinable logic, because "applying chaos" requires time, and it might be failed at first, and succeed in the next several retries, backoff also need time. So the time "when applied chaos" is not determinable.

That should be updated.

Clarify Cron scheduling information

Currently, the PodChaos docs page links off to https://pkg.go.dev/github.com/robfig/cron?utm_source=godoc for information about the cron format. There are a couple of issues with this:

  • The actual cron format needs to be documented. I think the cron spec for Chaos Mesh starts with minutes and includes the optional 'day of week' field, but this should be documented.
  • Document that all schedules are in UTC. This limitation is quite important, because it means something like setting up chaos only during business hours becomes non trivial, because cron schedules can't 'wrap' over midnight, so 9am to 5pm in your local time might have to be configured as two separate scheduled bits of chaos when converted to UTC.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.