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.

Sign up for GitHub

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

Jump to bottom

Resource policy documentation #6

Merged
merged 7 commits into from
Jun 12, 2023
Merged

Resource policy documentation #6

merged 7 commits into from
Jun 12, 2023

Commits on Jun 6, 2023

  1. docs: Generate documentation 

    Add documentation files and makefile rules to generate html
documentation for the project.

This is taken from cri-resource-manager and HEAD was at
commit 5db1e8a5fc0ec15780f5ffa6fbb2a9d826cb221b

Signed-off-by: Jukka Rissanen <[email protected]>
    @jukkar
    jukkar committed Jun 6, 2023
    Configuration menu
    Copy the full SHA
    4b09240 View commit details
    Browse the repository at this point in the history

  2. docs: Fix the heading level in code-of-conduct file 

    The heading level was wrong and was reported during doc
generation.

Signed-off-by: Jukka Rissanen <[email protected]>
    @jukkar
    jukkar committed Jun 6, 2023
    Configuration menu
    Copy the full SHA
    1d54a78 View commit details
    Browse the repository at this point in the history

  3. sample-configs: Add example configs needed by docs 

    The sample configuration files are referenced by the documentation
so we need to have them here.

Signed-off-by: Jukka Rissanen <[email protected]>
    @jukkar
    jukkar committed Jun 6, 2023
    Configuration menu
    Copy the full SHA
    a843030 View commit details
    Browse the repository at this point in the history

  4. e2e: Add help to run.sh script 

    User can say "run.sh help" to get information about the
functions available.

Signed-off-by: Jukka Rissanen <[email protected]>
    @jukkar
    jukkar committed Jun 6, 2023
    Configuration menu
    Copy the full SHA
    584a189 View commit details
    Browse the repository at this point in the history

  5. docs: Raw conversion / fixes to pass doc generation 

    This is just a raw conversion and fixes so that "make docs"
will pass and generate the documentation. Subsequent commits
will do more changes to the actual content.

Signed-off-by: Jukka Rissanen <[email protected]>
    @jukkar
    jukkar committed Jun 6, 2023
    Configuration menu
    Copy the full SHA
    9f3f467 View commit details
    Browse the repository at this point in the history

  6. docs: Updating the text for the NRI resource policy plugin 

    Changing the documentation so that it will describe how the
nri-resource-policy plugin works.

Also reshuffling the files around to better fit the overall
documentation structure.

Signed-off-by: Jukka Rissanen <[email protected]>
    @jukkar
    jukkar committed Jun 6, 2023
    Configuration menu
    Copy the full SHA
    75fb370 View commit details
    Browse the repository at this point in the history

Commits on Jun 8, 2023

  1. docs: Remove installation and quick-start instructions 

    These are to be rewritten by a Helm chart support commits
coming in near future.

Signed-off-by: Jukka Rissanen <[email protected]>
    @jukkar
    jukkar committed Jun 8, 2023
    Configuration menu
    Copy the full SHA
    138b963 View commit details
    Browse the repository at this point in the history