project-zot / docs-zot Goto Github PK
View Code? Open in Web Editor NEWzot registry documentation
zot registry documentation
Plan chapter and section titles for the zot documentation (User's Guide)
Asana: https://app.asana.com/0/1201943030057471/1201943030057481
Shoot Rav Video for the Getting Started Video
Asana https://app.asana.com/0/1201943030057471/1201950111670464
Title will be changed when the use case listing is done from development
Check out https://istio.io/latest/about/service-mesh/
May include a comparison with competitors.
Where does ZOT fit into the ecosystem? What other tooling are we integrating with (for example Notary) in order to obtain a complete solution?
The source repository will need a high level roadmap for the work to be done for zot. This will sourced from Github milestones.
Asana https://app.asana.com/0/1201943030057471/1201950111670455
https://zotregistry.io/docs-zot/zot-docs-1/1.0/admin-guide/admin-guide.html#_local_storage_config
Current questions:
A short video will be available on the main page of the site, and from the YouTube Channel.
Asana: https://app.asana.com/0/1201943030057471/1201943030057485
Title will be changed when the use case listing is done from development
Asana https://app.asana.com/0/1201943030057471/1201950111670544
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.
Similar to https://istio.io/latest/docs/
such that all high-level docs are in one place - a toc in a landing page, and readers can then choose.
Using the storyboard for the launch demo, develop, practice and record the launch demo to use for live and virtual events
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:
Clean an cruft out of the site repository caused by early development, make sure the repo README, license and other work is launch ready.
Asana: https://app.asana.com/0/1201943030057471/1201943030057505
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
Use the storyboard to shoot the raw footage for zot authentication
"realm" and "service" attributes need a definition.
We're going to do a video focus on configuring storage, write a storyboard for this topic
Do the video editing, and publish the storage setup video to Youtube, and docs site
Shoot the footage for the storage video
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
org.label-schema.*
keys and which with the org.opencontainers.image.*
keys?Video edit and publish the Getting Started Video to YouTube, the Docs Site, and Main Site
The Getting Started Video will have accompanying step-by-step documentation
Asana: https://app.asana.com/0/1201943030057471/1201943030057487
In our series of educational videos we'll do a video on setting up the various authentication and authorization options in zot
When the user first opens the http://zotregistry.io/docs-zot website, he will see a page which would allow him to pick which guide to access (instead of being directed straight to the developer or admin guide).
Update section http://zotregistry.io/docs-zot/zot-docs-1/1.0/admin-guide/admin-guide.html#_building_and_deploying_a_zot_container_image_from_source
Current questions which need to be answered and documentation updates:
Update the Zot Docs UI to be responsive for different screen sizes.
We'll do a press release for Cisco, for the Cloud Networking Newsletter and to other publications willing to announce zot.
The development team will need to provide a use case listing, these will drive the work to be done on the zot blog on medium
Asana: https://app.asana.com/0/1201943030057471/1201943030057491
Title will be changed when the use case listing is done from development
Asana https://app.asana.com/0/1201943030057471/1201950111670542
Check out https://istio.io/latest/docs/concepts/
Includes investigating how to implement the task using the Antora framework.
Create the antora playbook for the docs site
Calendar should be created to track the following regular events for public coordination
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
Write the Getting Started Documentation from the Outline to release along with the video
Asana: https://app.asana.com/0/1201943030057471/1201950111670488
We want to have a launch demo for release to teams within Cisco to generate some interest in zot throughout Cisco, as we head toward OSS. This demo should be
Reorganize the docs repository to clean up drafts for tocs into their own area and ensure the layout fits the Antora model.
Asana: https://app.asana.com/0/1201943030057471/1201943030057503
Create a blog site for zot on medium
Asana: https://app.asana.com/0/1201943030057471/1201950111670557
Title will be changed when the use case listing is done from development
Asana https://app.asana.com/0/1201943030057471/1201950111670542
Create antora UI theme for the docs site that seamlessly flows with the website.
The zot readme should have flow similar to the zot main site. It will be more developer an contributor focused, but must callout to the web and docs sites which will be the primary source for information.
Asana: https://app.asana.com/0/1201943030057471/1201943030057509
Edit and Publish the authentication video. Publish to YT and the docs site
Since we are using Antora, we have the ability version control documentation in the same manner as we do source control
== Requirements
Asana https://app.asana.com/0/1201943030057471/1201950111670457
Useful to research how the istio project organized the installation guide:
https://istio.io/latest/docs/setup/install/
Title will be changed when the use case listing is done from development
Asana https://app.asana.com/0/1201943030057471/1201950111670550
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.