Skip to content

Conversation

@EMaksy
Copy link
Member

@EMaksy EMaksy commented Jun 13, 2025

Purpose of this PR (WIP)

This PR aims to lay the foundation for a unified documentation repository that combines both user-facing and developer documentation for the Trento project.
The docs repository will be the source for the upcoming single documentation page

About the directory structure:
components: All the upstream projecs docs like web and wanda
dev_docs: All developer focused documentation like adr architecture coding standarts and so on
trento_suse: All documantation which is published at suse.com

docs/
├── components/     # Upstream project docs (e.g., web, wanda)
├── dev_docs/       # Developer-focused docs (ADRs, architecture, coding standards)
├── trento_suse/    # User-facing docs published on suse.com
├── dev_docs_legacy/ # Legacy docs (temporary, pending review & cleanup)
├──  templates/ # Contains templates like badges and guides.
└── modules/ # Contains antora modules with navigation files for the antora page

Important notes

  • All documentation meant to be published on the documentation site must:
  • Be written in Asciidoc (.adoc)
  • Be placed in the correct directory
  • Have the corresponding module's nav.adoc file updated (see README.md for guidance)
  • Documentation not intended for the public developer docs (e.g., notes, internal guides) can remain in Markdown or other formats and does not need to follow Antora conventions.

This PR includes multiple steps:

  • Add CI validation for user-facing SUSE docs
  • Update license year
  • Update README.md with instructions for Antora setup and usage
  • Add Antora site build cookbook and navigation modules (antora.yml)
  • Restructure the repo:
    • Move converted .adoc content into dev_docs
    • Fetch and convert upstream docs into components
  • fetched upstream project docs to components directory and convert them to adoc
  • Preserve old docs under dev_docs_legacy/ (to be cleaned up after discussions)

@EMaksy EMaksy self-assigned this Jun 13, 2025
@EMaksy EMaksy added documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested labels Jun 13, 2025
@EMaksy EMaksy force-pushed the fetch_docs_from_upstream branch 3 times, most recently from 6fcb4fe to 456efe5 Compare June 13, 2025 15:04
@EMaksy EMaksy force-pushed the fetch_docs_from_upstream branch from 456efe5 to e6e2c35 Compare June 13, 2025 15:18
@EMaksy EMaksy force-pushed the fetch_docs_from_upstream branch from 9383521 to e9fbb42 Compare June 13, 2025 15:31
@EMaksy EMaksy closed this Jul 11, 2025
@EMaksy EMaksy deleted the fetch_docs_from_upstream branch September 1, 2025 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested

Development

Successfully merging this pull request may close these issues.

2 participants