Skip to content

Conversation

@tromai
Copy link
Contributor

@tromai tromai commented Jun 1, 2023

Closes #239 .

@tromai tromai added the documentation Improvements or additions to documentation label Jun 1, 2023
@tromai tromai added this to the Release v0.1.0 milestone Jun 1, 2023
@tromai tromai requested a review from nathanwn June 1, 2023 05:16
@tromai tromai self-assigned this Jun 1, 2023
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Jun 1, 2023
@tromai tromai marked this pull request as ready for review June 1, 2023 07:51
@tromai tromai requested a review from behnazh-w as a code owner June 1, 2023 07:51
Trong Nhan Mai added 2 commits June 2, 2023 11:59
Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
@tromai
Copy link
Contributor Author

tromai commented Jun 2, 2023

I will rebase on staging to get the latest updates of the CLI options (from #270).

Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
@tromai tromai force-pushed the 239-add-the-content-for-the-cli-options-of-macaron-in-the-sphinx branch from fc12961 to 35893b4 Compare June 2, 2023 02:03
Command Line Usage
==================

You could use the bash script ``run_macaron.sh`` we provided to run Macaron as a Docker image (For more information on how to get this script, please see :ref:`Download Macaron <download-macaron>`).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
You could use the bash script ``run_macaron.sh`` we provided to run Macaron as a Docker image (For more information on how to get this script, please see :ref:`Download Macaron <download-macaron>`).
Use the bash script ``run_macaron.sh`` to run Macaron as a Docker container (for more information on how to get this script, please see :ref:`Download Macaron <download-macaron>`).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed in 602d683

.. code-block:: shell
./run_macaron.sh analyze -rp <repo_path>
./run_macaron.sh macaron analyze -rp <repo_path>
Copy link
Member

Choose a reason for hiding this comment

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

This file still contains ./run_macaron.sh macaron command. Please fix these.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed in 602d683

Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
@tromai tromai merged commit 2fc1b53 into staging Jun 2, 2023
@tromai tromai deleted the 239-add-the-content-for-the-cli-options-of-macaron-in-the-sphinx branch June 2, 2023 05:19
art1f1c3R pushed a commit that referenced this pull request Nov 29, 2024
…269)

Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation OCA Verified All contributors have signed the Oracle Contributor Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants