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

doc: new Clever Tools documentation #667

Merged
merged 1 commit into from
Feb 16, 2024
Merged

doc: new Clever Tools documentation #667

merged 1 commit into from
Feb 16, 2024

Conversation

davlgd
Copy link
Contributor

@davlgd davlgd commented Jan 26, 2024

It's an initial version, open to comments. Feel free to modify it widely.

@davlgd davlgd self-assigned this Jan 26, 2024
@davlgd davlgd requested a review from a team as a code owner January 26, 2024 22:12
@miton18
Copy link
Contributor

miton18 commented Feb 1, 2024

@davlgd can you rebase ?

aurrelhebert
aurrelhebert reviewed Feb 1, 2024
View reviewed changes
Copy link
Member

@aurrelhebert aurrelhebert left a comment

Choose a reason for hiding this comment

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

LGTM, however I do worry about the parameters description (as they may evolve and won't always be propagated in the documentation)

docs/README.md Outdated Show resolved Hide resolved
bin/clever.js Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/addons-backups.md Outdated Show resolved Hide resolved
docs/applications-config.md Outdated Show resolved Hide resolved
docs/applications-management.md Outdated Show resolved Hide resolved
docs/nexus-config.md Outdated Show resolved Hide resolved
docs/nexus-config.md Outdated Show resolved Hide resolved
docs/services-depedencies.md Outdated Show resolved Hide resolved
docs/services-notifications-webhooks.md Outdated Show resolved Hide resolved
@davlgd
Copy link
Contributor Author

davlgd commented Feb 1, 2024 •
edited
Loading

@davlgd can you rebase ?

It's done ✅

@davlgd
Copy link
Contributor Author

davlgd commented Feb 1, 2024

LGTM, however I do worry about the parameters description (as they may evolve and won't always be propagated in the documentation)

As previously discussed, this manual documentation is just a bootstrap, it will be automated in a next step. But we needed an up to date doc in the meantime.

@davlgd davlgd force-pushed the davlgd-doc-create branch from d6149a1 to b99fb8a Compare February 1, 2024 10:17
aurrelhebert
aurrelhebert approved these changes Feb 16, 2024
View reviewed changes
Copy link
Member

@aurrelhebert aurrelhebert left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for this PR 👍

@davlgd davlgd force-pushed the davlgd-doc-create branch 2 times, most recently from eb58a2a to 1b34844 Compare February 16, 2024 08:47
@davlgd
Copy link
Contributor Author

davlgd commented Feb 16, 2024

I made some more addon > add-on change in commands documentation, I'll do a regulation pass in commands "show help" code in a next PR to reflect them.

hsablonniere
hsablonniere approved these changes Feb 16, 2024
View reviewed changes
Copy link
Member

@hsablonniere hsablonniere left a comment

Choose a reason for hiding this comment

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

Thanks a lot @davlgd, this is great!!!!

I rebased and squashed your commits BTW.

@github-actions GitHub Actions
Copy link

🔎 A preview has been automatically published:

  • 🐧 linux db4a79bb8c7eadac2938c8ce90f494eaf950889e3e087c4975a67d55ea003d3c
  • 🍏 macos 3efc6b805c6defacbd15a69091adb67ecdd7371f40e69e15f932ac9598182015
  • 🪟 win 98fb4bc8d3df31fa03c8e57479296bba6fd28cbf1c765fb8cb8cde6f241d25b5

This preview will be deleted once this PR is closed.

@davlgd
Copy link
Contributor Author

davlgd commented Feb 16, 2024

Thanks, I'll introduce some changes in a coming PR depending on what's been merged and recent modifications.

@hsablonniere hsablonniere merged commit ab16b54 into master Feb 16, 2024
6 checks passed
@hsablonniere hsablonniere deleted the davlgd-doc-create branch February 16, 2024 09:23
@github-actions GitHub Actions
Copy link

🔎 The preview has been automatically deleted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aurrelhebert aurrelhebert aurrelhebert approved these changes

@hsablonniere hsablonniere hsablonniere approved these changes

Assignees

@davlgd davlgd

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@davlgd @miton18 @hsablonniere @aurrelhebert