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

NC | Upstream Docs Refactoring #8162

Merged
merged 1 commit into from
Jul 11, 2024
Merged

NC | Upstream Docs Refactoring #8162

merged 1 commit into from
Jul 11, 2024

Conversation

romayalon
Copy link
Contributor

@romayalon romayalon commented Jun 24, 2024 •
edited
Loading

Explain the changes

  • Created the following docs for NooBaa Non Containerized -
  1. Getting started
  2. Configuration
  3. NooBaa CLI
  4. Accounts and Buckets.
  5. Health
  6. Logging
  7. Monitoring
  8. Events
  9. Troubleshooting
  10. Supported S3 operations
  11. Limitations
  12. CI & Tests
  13. Upgrade
  • Updated formatting of config file customizations doc.

Issues: Fixed #xxx / Gap #xxx

  1. Delete the old non_containerized_nsfs doc.
  2. Fixed NSFS | Add a sample of metrics output to nsfs docs #7820

Testing Instructions:

  • Doc added/updated
  • Tests added

@romayalon romayalon force-pushed the romy-nc-docs branch 5 times, most recently from 40e325c to d390f30 Compare June 25, 2024 08:52
shirady
shirady reviewed Jun 26, 2024
View reviewed changes
Copy link
Contributor

@shirady shirady left a comment •
edited
Loading

Choose a reason for hiding this comment

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

A few comments in the files:

  1. Index
  2. Getting Started
  3. Configuration

docs/NooBaaNonContainerized/GettingStarted.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/GettingStarted.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/GettingStarted.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/GettingStarted.md Show resolved Hide resolved
docs/NooBaaNonContainerized/GettingStarted.md Show resolved Hide resolved
docs/NooBaaNonContainerized/Configuration.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/Configuration.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/Configuration.md Show resolved Hide resolved
docs/NooBaaNonContainerized/Configuration.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/GettingStarted.md Outdated Show resolved Hide resolved
shirady
shirady reviewed Jun 27, 2024
View reviewed changes
docs/NooBaaNonContainerized/GettingStarted.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/Configuration.md Show resolved Hide resolved
docs/NooBaaNonContainerized/Configuration.md Show resolved Hide resolved
docs/NooBaaNonContainerized/Configuration.md Outdated

`certificates/`
* <u>Type</u>: Directory.
* <u>Required</u>: False.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would also remove the dot of those keys ("No.", "File."), for a cleaner look.

shirady
shirady reviewed Jun 27, 2024
View reviewed changes
Copy link
Contributor

@shirady shirady left a comment

Choose a reason for hiding this comment

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

ConfigFileCustomizations comments

docs/NooBaaNonContainerized/ConfigFileCustomizations.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/ConfigFileCustomizations.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/ConfigFileCustomizations.md Show resolved Hide resolved
docs/NooBaaNonContainerized/ConfigFileCustomizations.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/ConfigFileCustomizations.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/ConfigFileCustomizations.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/ConfigFileCustomizations.md Show resolved Hide resolved
docs/NooBaaNonContainerized/ConfigFileCustomizations.md Show resolved Hide resolved
docs/NooBaaNonContainerized/ConfigFileCustomizations.md Show resolved Hide resolved
docs/NooBaaNonContainerized/ConfigFileCustomizations.md Show resolved Hide resolved
shirady
shirady reviewed Jun 30, 2024
View reviewed changes
Copy link
Contributor

@shirady shirady left a comment

Choose a reason for hiding this comment

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

Adding NooBaaCLI comments

docs/NooBaaNonContainerized/NooBaaCLI.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/NooBaaCLI.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/NooBaaCLI.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/NooBaaCLI.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/NooBaaCLI.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/NooBaaCLI.md Show resolved Hide resolved
docs/NooBaaNonContainerized/NooBaaCLI.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/NooBaaCLI.md Show resolved Hide resolved
docs/NooBaaNonContainerized/NooBaaCLI.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/NooBaaCLI.md Outdated Show resolved Hide resolved
shirady
shirady reviewed Jul 7, 2024
View reviewed changes
Copy link
Contributor

@shirady shirady left a comment

Choose a reason for hiding this comment

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

A few comments on Health and Logging

docs/NooBaaNonContainerized/Health.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/Health.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/Health.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/Health.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/Health.md Show resolved Hide resolved
docs/NooBaaNonContainerized/Logging.md Outdated Show resolved Hide resolved
docs/NooBaaNonContainerized/Logging.md Show resolved Hide resolved
docs/NooBaaNonContainerized/Logging.md Show resolved Hide resolved
docs/NooBaaNonContainerized/Logging.md Show resolved Hide resolved
docs/NooBaaNonContainerized/Logging.md Outdated Show resolved Hide resolved
@romayalon romayalon force-pushed the romy-nc-docs branch 2 times, most recently from 228fe8a to b4618e2 Compare July 11, 2024 07:42
@romayalon
NC | docs refactoring
8ed9d83 
Signed-off-by: Romy <35330373+romayalon@users.noreply.github.com>
@romayalon romayalon merged commit cc240ff into noobaa:master Jul 11, 2024
10 checks passed
@shirady shirady mentioned this pull request Jul 16, 2024
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shirady shirady shirady left review comments

@nimrod-becker nimrod-becker nimrod-becker approved these changes

@guymguym guymguym Awaiting requested review from guymguym

@tangledbytes tangledbytes Awaiting requested review from tangledbytes

@naveenpaul1 naveenpaul1 Awaiting requested review from naveenpaul1

Assignees
No one assigned
Labels
size/XXL
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

NSFS | Add a sample of metrics output to nsfs docs
3 participants
@romayalon @nimrod-becker @shirady