What is expected

Adding an explanation about how to use the rit create formula input flags on the documentation.

References

Original ISSUE: ZupIT/ritchie-cli#712
Pull Request: ZupIT/ritchie-cli#950

What is expected

Adding an explanation about how the rit rename formula core command works on the documentation.

• add new "how to" section (in Formulas)
• update input flag core command list (Standard Inputs section)

References

Original ISSUE: ZupIT/ritchie-cli#817
Pull Request: ZupIT/ritchie-cli#907

New ISSUE referring to ZupIT/ritchie-cli#1015 opened from https://github.com/ZupIT/ritchie-cli/issues through the open-issue-action.

As the FAQ and Tutorials are the same for the different versions, it is suggested to place them at the root of the bucket. This will make the space used in S3 better utilized.

Thus, upload workflows must be handled to, in addition to images, upload the FAQ and Tutorials in the root of the bucket.

Ref: https://github.com/ZupIT/charlescd-docs/issues/5

We are missing instructions on how to perform a manual update without losing any saved data from Ritchie

What is expected

Adding an explanation about how the rit update workspace core command works on the documentation.

• update input flag core command list (Standard Inputs section)

References

Original ISSUE: ZupIT/ritchie-cli#865
Pull Request: ZupIT/ritchie-cli#922

New ISSUE referring to ZupIT/ritchie-cli#1019 opened from https://github.com/ZupIT/ritchie-cli/issues through the open-issue-action.

The idea is to optimize the space used in the bucket through the action compress-image.

For this, it will be necessary to adjust the existing workflows so that they compress the images before uploading to S3.

I was looking for Ritchie's "Contributing guides".

And I did read some of the documents that I found on Ritchie's Github repositories.

But, as there is a Document Portal, it would be easier for us to also see them published at the portal.

Please, could you update the license footer to use Creative Commons instead?

https://creativecommons.org/licenses/by/4.0/

You can use this site as a reference:

https://creativecommons.org/choose/results-one?license_code=by&jurisdiction=&version=4.0&lang=en

Simple sample of footer

<p>&copy; 2021 Zup IT <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons</a> <a href="https://insights.zup.com.br/politica-privacidade">Privacy Policy</a></p>

Ps: In the English version, we need to check the English version of this policy: https://insights.zup.com.br/politica-privacidade

Docs website: https://docs.ritchiecli.io/v2.11/

Standardize the name of files and images, and remove images that are duplicated.

What is expected

Adding an explanation about how to use the rit init input flags on the documentation.

References

Original ISSUE: ZupIT/ritchie-cli#717
Pull Request: ZupIT/ritchie-cli#932

What is expected

Adding an explanation about how to use the rit delete repo input flags on the documentation.

References

Original ISSUE: ZupIT/ritchie-cli#718
Pull Request: ZupIT/ritchie-cli#906 + ZupIT/ritchie-cli#908

All links that redirect to the documentation itself are not working.

Thus, it is necessary to adjust all the links as shown below:

[Link]({{< ref path="filename.md" >}})

The programatic way to execute rit create formula has a non-working example in the Core commands page.

A working example follows below:

cat << EOF |
{
    "formulaCmd": "rit oioi teste",
    "lang": "shell-bat",
    "workspace": {"name": "my-formulas", "dir": "/home/fulano/projetos/xxx" },
    "formulapath": "/home/fulano/projetos/xxx/oioi/teste/"
  }
EOF
rit create formula --stdin

If there is another way to do the same without stdin (using flags) current docs do not show it too.

What is expected

Adding an explanation of the force-update option on the official documentation.

References

Original ISSUE: ZupIT/ritchie-cli#849
Pull Request: ZupIT/ritchie-cli#883

New ISSUE referring to ZupIT/ritchie-cli#871 opened from https://github.com/ZupIT/ritchie-cli/issues through the open-issue-action.

What we need

• We need to think about a new structure for the documentation that will be more adapted to user and developer profiles.

The formula implementation section if not showing correctly, neither in English nor in Portuguese. This section is important because it has information about the config.json file

What is expected

Adding an explanation about how to use the rit set env input flags on the documentation.

References

Original ISSUE: ZupIT/ritchie-cli#719
Pull Request: ZupIT/ritchie-cli#923

What is expected

• A new page explaining how to test formula using
  • unit tests
  • formulas outputs for Github formulas repository using the test-cli-commands-action that has been implemented for the Ritchie CLI core commands funcional tests.

Why is it needed

• There is no section on the documentation explaining how to increase Ritchie formulas' implementation quality and best practices.

New ISSUE referring to ZupIT/ritchie-cli#940 opened from https://github.com/ZupIT/ritchie-cli/issues through the open-issue-action.

What is expected:

• A new section explaining how to use workspaces commands:
  • rit add workspace
  • rit list workspace
  • rit update workspace
  • rit delete workspace

Tasks

• EN
• PT

Resume

Improves readme to include all necessary steps to clone and run docs locally.

Important points to include

• Needs hugo extended version to run local
• Uses git submodules, I recommend cloning with the --recurse-submodules flag or use git submodule update --init --recursive after cloning

Why

To improve adoption by new users.

What is expected

• Add RPM, DEB, ArchLinux and Winget installers on the Getting started section for Linux and Windows.

Why is it needed

• To increase Ritchie CLI adoption and provide more flexibility to users.

Suggestion to improve navigation

Instead of using the How to Implement Formulas section with various sub-section: Formula Folder, Config File, Main File, Dependencies it could be interesting to create separated tutorials explaining how to configure the formula, such as:

• How to organize the formula folder
• How to configure inputs
• How to use input variables in a formula
• How to add formula dependencies
• How to make the formula compatible with Docker

What is expected

Adding an explanation of the rit list formula command on the official documentation.

References

Original ISSUE: ZupIT/ritchie-cli#857
Pull Request: ZupIT/ritchie-cli#913

New ISSUE referring to ZupIT/ritchie-cli#945 opened from https://github.com/ZupIT/ritchie-cli/issues through the open-issue-action.

What is expected

Add explanation about ZupIT/ritchie-cli#897 in the config.json section.

This page is missing on the english version of the documentation:

https://docs.ritchiecli.io/tutorials/formulas/how-to-run-formulas/hello-world-formula

The portuguese version is ok.

New ISSUE referring to ZupIT/ritchie-cli#943 opened from https://github.com/ZupIT/ritchie-cli/issues through the open-issue-action.

What is expected

Adding an explanation about how to use the rit update repo input flags on the documentation.

References

Original ISSUE: ZupIT/ritchie-cli#722
Pull Request: ZupIT/ritchie-cli#916

New ISSUE referring to ZupIT/ritchie-cli#1016 opened from https://github.com/ZupIT/ritchie-cli/issues through the open-issue-action.

New ISSUE referring to ZupIT/ritchie-cli#1020 opened from https://github.com/ZupIT/ritchie-cli/issues through the open-issue-action.

Related to: #145

What is expected

• A new tutorial page to explain how to test a Ritchie formula.

Why is it needed

• To explain how to use the test-cli-commands-action that has been implemented for the Ritchie CLI core commands funcional tests.

What is expected

Adding an explanation about how to use the rit delete formula input flags on the documentation.

References

Original ISSUE: ZupIT/ritchie-cli#716
Pull Request: ZupIT/ritchie-cli#961

Test message

Description

Today the default installer exists for sudo to run, but when running on systems already with root user it is neither necessary nor possible to use sudo.

Example

Today to install on servers or docker containers without sudo we need to do the following command to remove sudo from the installer curl -fsSL https://commons-repo.ritchiecli.io/install.sh | sed -e 's/sudo//g' | bash

We should add this option to the installation options for Unix OS.

Referred to: ZupIT/ritchie-cli#921

New ISSUE referring to ZupIT/ritchie-cli#965 opened from https://github.com/ZupIT/ritchie-cli/issues through the open-issue-action.

New ISSUE referring to ZupIT/ritchie-cli#1014 opened from https://github.com/ZupIT/ritchie-cli/issues through the open-issue-action.

• Substitute the Gitbook documentation URL by the Hugo documentation .
• Substitute the Gitbook documentation by the Hugo documentation on the Landing Page and Github repositories.

Could you please update the repository name to ritchie-docs?

Ref: https://github.com/ZupIT/docs-horusec/issues/97

New ISSUE referring to ZupIT/ritchie-cli#1032 opened from https://github.com/ZupIT/ritchie-cli/issues through the open-issue-action.