Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create Documentation Scaffolding #461

Merged
merged 6 commits into from
Dec 20, 2024
Merged

Create Documentation Scaffolding #461

merged 6 commits into from
Dec 20, 2024

Conversation

vikman90
Copy link
Member

@vikman90 vikman90 commented Dec 20, 2024 •
edited
Loading

Related issue
Closes #371

This PR aims to introduce a documentation scaffolding, according to the requirements.

Preview

image

Scaffolding

Summary

  • Introduction

Development Documentation

  • Introduction
  • Setup Environment
  • Build Packages
  • Build Image
  • Build from Sources
  • Run from Sources
  • Run Tests

Reference Manual

  • Introduction
    • Description
    • Architecture
    • Compatibility
  • Getting Started
    • Requirements
    • Packages
    • Installation
  • Configuration
  • Modules
    • File Integrity monitoring
      • Architecture
      • API Reference
    • Inventory
      • Architecture
      • API Reference
    • Logcollector
      • Architecture
      • API Reference
  • Upgrade
  • Uninstall
  • Back Up and Restore
  • Security
  • Performance
  • Glossary

Diagnostic Documentation

  • Diagnostic Guide

Scripts

  • build.sh: Builds the HTML documentation into book folder.
  • server.sh: Serves the documentation as an HTTP server for local preview.

@vikman90 vikman90 requested a review from gdiazlo December 20, 2024 13:17
@vikman90 vikman90 self-assigned this Dec 20, 2024
@vikman90 vikman90 linked an issue Dec 20, 2024 that may be closed by this pull request
Create a Documentation System for the Repository #371
Closed
@vikman90 vikman90 changed the title Feature/371 documentation Create Documentation Scaffolding Dec 20, 2024
@vikman90 vikman90 mentioned this pull request Dec 20, 2024
Closed
gdiazlo
gdiazlo approved these changes Dec 20, 2024
View reviewed changes
Copy link
Member

@gdiazlo gdiazlo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@gdiazlo gdiazlo merged commit 5af3f98 into master Dec 20, 2024
5 checks passed
@gdiazlo gdiazlo deleted the feature/371-documentation branch December 20, 2024 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gdiazlo gdiazlo gdiazlo approved these changes

Assignees

@vikman90 vikman90

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create a Documentation System for the Repository
2 participants
@vikman90 @gdiazlo