Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@claudiolor
Copy link
Contributor

Description

This PR introduces some pages with a reference of the liqoctl commands and includes:

  • Removal of the liqoctl docs command, as there is no need to bundle a command to generate the documentation inside liqoctl itself
  • Creation of a small application under hack allowing to generate the mardown of the liqoctl documentation
  • Added ctldocs to the Makefile to build the liqoctl documentation

To generate both Helm and liqoctl documentation is enough calling:

make docs

@adamjensenbot
Copy link
Collaborator

Hi @claudiolor. Thanks for your PR!

I am @adamjensenbot.
You can interact with me issuing a slash command in the first line of a comment.
Currently, I understand the following commands:

  • /rebase: Rebase this PR onto the master branch (You can add the option test=true to launch the tests
    when the rebase operation is completed)
  • /merge: Merge this PR into the master branch
  • /build Build Liqo components
  • /test Launch the E2E and Unit tests
  • /hold, /unhold Add/remove the hold label to prevent merging with /merge

Make sure this PR appears in the liqo changelog, adding one of the following labels:

  • feat: πŸš€ New Feature
  • fix: πŸ› Bug Fix
  • refactor: 🧹 Code Refactoring
  • docs: πŸ“ Documentation
  • style: πŸ’„ Code Style
  • perf: 🐎 Performance Improvement
  • test: βœ… Tests
  • chore: 🚚 Dependencies Management
  • build: πŸ“¦ Builds Management
  • ci: πŸ‘· CI/CD
  • revert: βͺ Reverts Previous Changes

@github-actions github-actions bot added the chore Miscellaneous tasks that don't modify application logic (e.g., updating dependencies or build tasks) label Mar 12, 2025
@claudiolor claudiolor force-pushed the clo/liqoctl-docs branch 2 times, most recently from 6017a1f to 525c24d Compare March 12, 2025 16:15
@frisso
Copy link
Member

frisso commented Mar 13, 2025

Hello @claudiolor
This looks very useful to me, thanks!
Not sure I've understood everything, though. Is this going to generate a markdown page about liqoctl that can be included in the docs.liqo.io website?
Thanks!

@claudiolor
Copy link
Contributor Author

Hey @frisso,
yes the aim of this PR is adding to the docs.liqo.io website an automatically generated documentation of the liqoctl commands.
Once #2989 is merged, I will be able to generate the .md files to be added to the website.

@github-actions github-actions bot added the docs Updates or adds documentation label Mar 19, 2025
@claudiolor claudiolor force-pushed the clo/liqoctl-docs branch 2 times, most recently from c61727b to 3453181 Compare March 19, 2025 10:22
@claudiolor claudiolor marked this pull request as ready for review March 19, 2025 10:48
@claudiolor
Copy link
Contributor Author

/test

@fra98
Copy link
Member

fra98 commented Mar 20, 2025

/merge

@adamjensenbot adamjensenbot added the merge-requested Request bot merging (automatically managed) label Mar 20, 2025
@adamjensenbot adamjensenbot merged commit 4f27435 into liqotech:master Mar 20, 2025
14 checks passed
@adamjensenbot adamjensenbot removed the merge-requested Request bot merging (automatically managed) label Mar 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Miscellaneous tasks that don't modify application logic (e.g., updating dependencies or build tasks) docs Updates or adds documentation size/XXL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants