Coder Social home page Coder Social logo

docs-zot's People

Contributors

chofnar avatar dependabot[bot] avatar raulkele avatar rchincha avatar

Watchers

 avatar

docs-zot's Issues

Document steps for the user to build/push container images having all fields consumed by zui and shown in the image and repo cards

Ideally as part of the docs-zot repo.

Currently our queries return ImageSummary objects containing information originating in the image config object (see: https://github.com/opencontainers/image-spec/blob/main/config.md).
More specifically we use pre-defined labels from https://github.com/opencontainers/image-spec/blob/main/annotations.md#rules.

The labels we used at the moment in zot are: https://github.com/project-zot/zot/blob/8ffb053cec01bd7541ef40679f5ad24d44070fce/pkg/extensions/search/common/common.go#L106

  1. We are interested to know what steps a user needs to make in order to build images containing those labels. What skopeo/docker/podman settings does he need to use in order to obtain images with those labels?
  2. What steps does the user need to take at build time in order to set Annotations in the manifest https://github.com/opencontainers/image-spec/blob/main/manifest.md
  3. Are we using these fields correctly? What's the difference between the annotations/labels mentioned above? Do we need to update the linter rules to verify Labels in the image config instead of annotations in the manifest?
  4. How to set image Author per https://github.com/opencontainers/image-spec/blob/main/config.md?
  5. Which of the tools generate/add labels with the org.label-schema.* keys and which with the org.opencontainers.image.* keys?

Write requirements for Getting Started Guide

The getting started guide should be a short section with steps to download zot , and deploy it with minimum configuration.
Note: According to the mocks, the landing page will link to it in one of the sections.

Write initial requirements for the User Guide

The zot documentation website currently includes an Admin Guide and a Developer Guide.
We're missing a guide for the regular user.
This task tracks providing the requirements for the User Guide

Establish a Documentation Pipeline

Since we are using Antora, we have the ability version control documentation in the same manner as we do source control

== Requirements

  • Documentation is always worked from the main/master branch.
  • The CI/CD pipeline for this repository will have various checks (TBD)
  • When a zot release is created, a version of the documentation will be tagged, matching the source control.
  • The anotora configuration will be adjusted to pull source code for that version

Asana https://app.asana.com/0/1201943030057471/1201950111670457

Integrate zot documentation code with zot landing page

The content needs to be served by the same web service.
Links for navigating in between should be functional.

Also tracks updating the following links on the zot website:

  • "What is zot" / "How it works" button - will redirect to high level concepts https://docs.zotregistry.io/zot-docs-1/1.0/general/zot-concepts.html - done
  • "What is zot" / "More Details" button - @rchincha to come up with the desired target, for now it should point to docs home page
  • "Home" in the zot docs should point to the new version of the website
  • We will remove "Privacy" - done
  • "Copyright @2022 Cisco Systems" / License updates - done

Create site build automation

site-zot and docs-zot are antora repos. Antora is a documentation system backed on top of asciidoctor aimed at documentation of very technical websites like software projects.

This process will involve

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.