devstream icon indicating copy to clipboard operation
devstream copied to clipboard

:open_book: `Docs`: GitOps Best Practice Doc Improvement

Open IronCore864 opened this issue 3 years ago • 0 comments

What should be changed?

In the quickstart doc, we used a method where we execute a shell script that downloads dtm and the config file. Then we export env vars, and use sed to update the config file. This method only requires users to do 3 actions:

  • copy-paste the shell script and execute
  • export env vars
  • copy-paste the sed commands and run them

Compared to this, the GitOps doc requires users to download something manually, then update the config file manually.

Maybe as an improvement, we can make the GitOps doc the same as the quickstart doc, so that the user only needs to copy commands and run them then get a consistent result.

Please read the documents below.

  • [x] I've read the documents above. (If you want to submit a document type contribution.)

IronCore864 avatar Aug 03 '22 03:08 IronCore864