https://github.com/pedro-psb/the-docs-demo

Demo documentation site for Pulp Project
https://github.com/pedro-psb/the-docs-demo

Last synced: 12 days ago
JSON representation

Demo documentation site for Pulp Project

• Host: GitHub
• URL: https://github.com/pedro-psb/the-docs-demo
• Owner: pedro-psb
• Created: 2023-12-13T17:46:20.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-14T20:47:39.000Z (about 1 year ago)
• Last Synced: 2024-11-23T09:43:25.951Z (2 months ago)
• Language: Shell
• Homepage: https://pedro-psb.github.io/the-docs-demo/
• Size: 914 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Unified Documentation Demo for Pulp Project

This is a demo of using [Diataxis](#) ideas to scafold a new unified documentation for the Pulp Project with mkdocs.

The primary concerts of the demo is to orient content organization.

## Runninng Locally

```bash

$ pip install -r requirements.txt

$ mkdocs serve

```

## Docs workgroup Content TODO

- [ ] Landing Page: [this](https://aws.github.io/copilot-cli/) is an interesting mkdocs langing page example.

- [x] Top Section Overviews

- [ ] Getting Started

    - [ ] Quickstart: A 'content-agnostic' setup-to-deploy reference example with no pre-requisites.

    - [ ] Fundamentals: Some fundamental theoretical knowledge (in an article-like format) about Pulp and content-management.

    - [ ] Intermediate: move existing intermediate article-like content here. Or write from scratch?

- [ ] Getting Started

    - [ ] Any important core guides? Common-guides can prevent multiple plugins of writing basically the same.

- [ ] Reference

    - [ ] Repository Map: a table with summary of all plugins, link to repos and possibly other relevant info.

    - [ ] Glossary: the glossary.

    - [ ] pulpcore REST Api: setup appropriate plugins and scripts

    - [ ] pulpcore Codebase Api: setup appropriate plugins and scripts

    - [ ] Anything else?

- [ ] Community

    - [ ] About:

    - [ ] PulpCon:

    - [ ] Contributing:

        - [ ] Workflow: Common workflow for all repos

        - [ ] Guides:

        - [ ] Onboarding: