Skip to content
This repository was archived by the owner on Jan 21, 2025. It is now read-only.

add "excluded" to schema + add help/clean to docs#162

Merged
mordamax merged 9 commits intomasterfrom
mak/excluded-docs
Mar 1, 2023
Merged

add "excluded" to schema + add help/clean to docs#162
mordamax merged 9 commits intomasterfrom
mak/excluded-docs

Conversation

@mordamax
Copy link
Copy Markdown
Contributor

@mordamax mordamax commented Feb 15, 2023

Closes #170

In order to skip showing the "sample" example introduced an "exclude" flag to skip from docs.
We could simply delete "sample" and there's no problem but i found it useful often to check quickly that gitlab jobs with parameters work, so would prefer to keep.

  • Docs:
    • support "example" field from type_rule
    • skip rendering a table with args, if there's no args (also make it not required)
    • make help/clean so they go as first basic commands in docs
    • add "excluded" to schema, so some commands could be skipped in docs

@mordamax mordamax requested a review from a team as a code owner February 15, 2023 17:17

git checkout -b "$stg_branch"
git push origin "$stg_branch"
git push origin HEAD:"$stg_branch"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Love this simplified method

@mordamax mordamax requested a review from a team as a code owner February 16, 2023 12:37
@mordamax mordamax merged commit 68dcd07 into master Mar 1, 2023
@mordamax mordamax deleted the mak/excluded-docs branch March 1, 2023 23:54
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

improve docs

4 participants