Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve jinja docs #7785

Merged
merged 12 commits into from
Nov 2, 2021
Merged

Conversation

Mab879
Copy link
Member

@Mab879 Mab879 commented Oct 25, 2021

Description:

  • Adds docstrings to Jinja templates
  • Update style guide

Render at https://mburket-complianceascode.readthedocs.io/en/improve_jinja_docs/index.html

Rationale:

Improve developer experience

@Mab879 Mab879 added the Documentation Update in project documentation. label Oct 25, 2021
@Mab879 Mab879 added this to the 0.1.59 milestone Oct 25, 2021
@openshift-ci
Copy link

openshift-ci bot commented Oct 25, 2021

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Used by openshift-ci bot. label Oct 25, 2021
shared/macros-oval.jinja Outdated Show resolved Hide resolved
shared/macros-oval.jinja Outdated Show resolved Hide resolved
shared/macros-oval.jinja Outdated Show resolved Hide resolved
shared/macros-oval.jinja Outdated Show resolved Hide resolved
shared/macros-oval.jinja Outdated Show resolved Hide resolved
@Mab879 Mab879 marked this pull request as ready for review October 27, 2021 15:58
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Used by openshift-ci bot. label Oct 27, 2021
shared/macros-ansible.jinja Outdated Show resolved Hide resolved
shared/macros-ansible.jinja Outdated Show resolved Hide resolved
shared/macros-ansible.jinja Outdated Show resolved Hide resolved
shared/macros.jinja Outdated Show resolved Hide resolved
shared/macros.jinja Outdated Show resolved Hide resolved
shared/macros.jinja Outdated Show resolved Hide resolved
shared/macros.jinja Outdated Show resolved Hide resolved
shared/macros.jinja Outdated Show resolved Hide resolved
shared/macros.jinja Outdated Show resolved Hide resolved
shared/macros.jinja Outdated Show resolved Hide resolved
shared/macros-ansible.jinja Outdated Show resolved Hide resolved
shared/macros-highlevel.jinja Outdated Show resolved Hide resolved
shared/macros-kubernetes.jinja Show resolved Hide resolved
shared/macros-oval.jinja Outdated Show resolved Hide resolved
shared/macros-oval.jinja Outdated Show resolved Hide resolved
shared/macros-oval.jinja Outdated Show resolved Hide resolved
shared/macros.jinja Outdated Show resolved Hide resolved
shared/macros.jinja Outdated Show resolved Hide resolved
shared/macros.jinja Outdated Show resolved Hide resolved
shared/macros.jinja Outdated Show resolved Hide resolved
@ggbecker ggbecker self-assigned this Nov 1, 2021
shared/macros-oval.jinja Outdated Show resolved Hide resolved
shared/macros.jinja Outdated Show resolved Hide resolved
Co-authored-by: Gabriel Becker <ggasparb@redhat.com>
@openshift-ci
Copy link

openshift-ci bot commented Nov 2, 2021

@Mab879: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-aws-rhcos4-moderate 07fbf3d link true /test e2e-aws-rhcos4-moderate

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@ggbecker ggbecker merged commit ab1092c into ComplianceAsCode:master Nov 2, 2021
@Mab879 Mab879 deleted the improve_jinja_docs branch November 2, 2021 19:34
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Update in project documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants