docs: How to work with Storage

[vladklokun]

Type

Documentation

---

Description

This Pull Request aims to enhance the documentation on how to work with the Storage Aggregated APIServer. The main changes include:

• Instructions on how to generate code and build in the main README.
• Guidelines on how to run in local k8s for development.

---

PR changes walkthrough

Relevant files

Documentation

2 files README.md                                                                                                      README.md The README file has been updated with instructions on how to generate code and build the project. working_with_storage.md                                                                          docs/working_with_storage.md The documentation file for working with storage has been updated with guidelines on how to run the project in local k8s for development.

---

User description

What this PR changes?

This PR clarifies the documentation on how to work with the Storage Aggregated APIServer.

[github-actions[bot]]

Summary:

• License scan: failure
• Credentials scan: success
• Vulnerabilities scan: success
• Unit test: success
• Go linting: success

[codiumai-pr-agent[bot]]

PR Description updated to latest commit (https://github.com/kubescape/storage/commit/14832163a179fe721ecc8605f22fb34a645599be)

[codiumai-pr-agent[bot]]

PR Analysis

• 🎯 Main theme: Enhancing documentation for working with the Storage Aggregated APIServer

• 📝 PR summary: This PR updates the project's README with instructions on how to generate code, build the project, and run it in a local Kubernetes environment for development purposes.

• 📌 Type of PR: Documentation

• 🧪 Relevant tests added: No

• ⏱️ Estimated effort to review [1-5]: 1, because it's a documentation update with no code changes.

• 🔒 Security concerns: No

  PR Feedback

• 💡 General suggestions: The PR seems to be well-structured and focuses on improving the project's documentation, which is crucial for new contributors and for maintaining the project's health. It would be beneficial if the PR also included a section on how to contribute to the project, including coding standards, commit message guidelines, and the process for submitting pull requests.

• 🤖 Code feedback:

How to use

Instructions

> To invoke the PR-Agent, add a comment using one of the following commands: > **/review**: Request a review of your Pull Request. > **/describe**: Update the PR title and description based on the contents of the PR. > **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback. > **/ask \**: Ask a question about the PR. > **/update_changelog**: Update the changelog based on the PR's contents. > **/add_docs**: Generate docstring for new components introduced in the PR. > **/generate_labels**: Generate labels for the PR based on the PR's contents. > see the [tools guide](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details. >To edit any configuration parameter from the [configuration.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml), add --config_path=new_value. >For example: /review --pr_reviewer.extra_instructions="focus on the file: ..." >To list the possible configuration parameters, add a **/config** comment.

[github-actions[bot]]

Summary:

• License scan: failure
• Credentials scan: success
• Vulnerabilities scan: success
• Unit test: success
• Go linting: success

[github-actions[bot]]

Summary:

• License scan: failure
• Credentials scan: success
• Vulnerabilities scan: success
• Unit test: success
• Go linting: success

[github-actions[bot]]

Summary:

• License scan: failure
• Credentials scan: success
• Vulnerabilities scan: success
• Unit test: success
• Go linting: success