diff --git a/.gitignore b/.gitignore index c5aaabe..f6c1cf2 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,6 @@ jfrog-cli-retention-plugin *.DS_Store dist/ + +# Mkdocs +site/ \ No newline at end of file diff --git a/README.md b/README.md index 85e4c1f..35c249e 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,10 @@ # rt-retention -A JFrog CLI plugin to facilitate artifact retention in Artifactory. +A simple JFrog CLI plugin to facilitate enforcing retention policies in Artifactory. -## TL;DR +The plugin allows you to delete artifacts using [FileSpecs](https://www.jfrog.com/confluence/display/JFROG/Using+File+Specs) found in a given directory. -Deletes artifacts matching all [File Specs](https://www.jfrog.com/confluence/display/JFROG/Using+File+Specs) found in a given directory. - -Allows for generation of FileSpecs files through Go templates and a JSON configuration file. - -## Installation - -This plugin isn't currently hosted anywhere yet, so you'll be building it locally. - -You can use the [build.sh](scripts/build.sh) and [install.sh](scripts/install.sh) scripts. - -## Usage +It also allows for generation of FileSpecs through Go templates and a JSON configuration file. ### Commands diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/docs/stylesheets/theme.css b/docs/stylesheets/theme.css new file mode 100644 index 0000000..e2dff68 --- /dev/null +++ b/docs/stylesheets/theme.css @@ -0,0 +1,5 @@ +:root>* { + --md-primary-fg-color: #ad9ce3; + --md-primary-fg-color--light: #c0b7df; + --md-primary-fg-color--dark: #937cdd; +} \ No newline at end of file diff --git a/mkdocs.yaml b/mkdocs.yaml new file mode 100644 index 0000000..4c90b82 --- /dev/null +++ b/mkdocs.yaml @@ -0,0 +1,52 @@ +site_name: Artifactory Retention +site_url: https://rt-retention.verifa.io +site_description: >- + JFrog CLI plugin for facilitating Artifactory retention policies + +# Repository +repo_name: verifa/rt-retention +repo_url: https://github.com/verifa/rt-retention + +# Copyright +copyright: Copyright © 2022 Verifa + +# Theme +theme: + name: material + + font: + text: Outfit + features: + - navigation.indexes + - navigation.sections + - navigation.tabs + - navigation.top + - content.code.annotate + - toc.follow + +# Plugins +plugins: + - awesome-pages + - search + - tags + +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/verifa + +extra_css: + - stylesheets/theme.css + +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets: + check_paths: true + - pymdownx.superfences + - meta + - toc: + permalink: true diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..49f520c --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +# MKDocs requirements +mkdocs-material==8.5.9 +mkdocs-awesome-pages-plugin