Improve README with comprehensive project documentation

[chris1984]

Add proper project description, requirements, operating modes, development setup, testing instructions, and contributing guidelines.

Summary by Sourcery

Update the README with comprehensive user and contributor documentation for the ForemanRhCloud plugin, including usage, development, and architecture references.

Documentation:

• Document plugin purpose, key capabilities, and operating modes for ForemanRhCloud.
• Add detailed usage instructions for inventory upload, Insights recommendations, and inventory status sync via UI and CLI.
• Describe required dependencies and supported Foreman, Katello, and related plugin versions.
• Document cloud endpoint URLs and environment variable overrides used by the plugin.
• Add development, testing, linting, and local server setup instructions, plus a pointer to architecture documentation.
• Expand contributing guidelines with a clearer workflow for submitting changes.

Chores:

• Update copyright years and clean up minor formatting in the license notice.

[sourcery-ai]

Reviewer's Guide

README.md is overhauled into a full project guide, adding detailed feature description, operating modes, usage examples, cloud endpoint documentation, development and testing workflows, and contributing instructions, while cleaning up outdated sections and fixing minor formatting and copyright details.

Flow diagram for development and testing workflow from README

flowchart TD
  A[Start working on foreman_rh_cloud] --> B[Clone Foreman repository]
  B --> C[Clone foreman_rh_cloud plugin]
  C --> D[Install Ruby dependencies in Foreman root using bundle install]
  D --> E[Install JavaScript dependencies in plugin directory using npm install]

  E --> F[Run Ruby plugin test suite from Foreman root using bundle exec rake test:foreman_rh_cloud]
  F --> G[Optionally run a single Ruby test file with bundle exec rake test TEST=path]

  E --> H[Run JavaScript tests in plugin directory using npm test]
  H --> I[Optionally use npm run test:watch]
  H --> J[Optionally use npm run test:current]

  F --> K[Run Ruby linter in Foreman root using bundle exec rubocop --parallel]
  H --> L[Run JavaScript linter in plugin directory using npm run lint]

  K --> M[Optionally start development server from Foreman root using bundle exec foreman start]
  L --> M

  M --> N[Open UI and exercise Inventory Upload, Insights Recommendations, and Inventory Status Sync]

Loading

Flow diagram for contributing process from README

flowchart TD
  A[Decide to contribute to foreman_rh_cloud] --> B[Fork the repository]
  B --> C[Create a feature branch]
  C --> D[Make code or documentation changes]
  D --> E[Run Ruby and JavaScript tests]
  E --> F[Run Ruby and JavaScript linters]
  F --> G[Ensure all checks pass]
  G --> H[Submit a Pull Request]

Loading

File-Level Changes

Change	Details	Files
Rewrite README into a comprehensive user and contributor guide for the ForemanRhCloud plugin.	Add high-level project description and list of plugin capabilities including inventory upload, Insights recommendations, remediations, Cloud Connector, and client tools forwarding Document requirements such as required Foreman plugins and supported Ruby versions Clarify installation by linking directly to the Foreman wiki plugin installation guide Describe operating modes (Regular cloud mode vs. IoP on-premise mode) and how mode selection affects behavior, including a helper method to inspect the current mode Add detailed usage instructions for inventory upload, Insights recommendations sync, and inventory status sync via both UI flows and CLI rake tasks Normalize and extend cloud endpoint documentation, including default URLs and environment variable overrides in a markdown table Introduce development section with setup steps, explicit separation between Foreman root vs plugin directory usage, and JS dependency installation Add testing section covering Ruby and JavaScript test commands and how to run targeted tests Add linting and development server instructions to support local development workflows Replace inline design notes with a pointer to ARCHITECTURE.md for deeper technical documentation Expand contributing guidelines into a short checklist including running tests and linters before PR submission Update copyright years and clean up minor formatting, capitalization, and spacing in license boilerplate	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've found 1 issue, and left some high level feedback:

• In the Cloud Endpoints table, consider aligning the descriptions with the previous design section by either including or explicitly omitting query parameters so it’s clear whether the base URL or a fully parameterized endpoint is expected.
• The README now mixes generic /path/to/foreman instructions with concrete system locations used earlier (/usr/sbin/foreman-rake); it may help readers if you briefly note when distro-specific paths (e.g., Satellite packages) differ from development setups and how to adapt the commands.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- In the Cloud Endpoints table, consider aligning the descriptions with the previous design section by either including or explicitly omitting query parameters so it’s clear whether the base URL or a fully parameterized endpoint is expected.
- The README now mixes generic `/path/to/foreman` instructions with concrete system locations used earlier (`/usr/sbin/foreman-rake`); it may help readers if you briefly note when distro-specific paths (e.g., Satellite packages) differ from development setups and how to adapt the commands.

## Individual Comments

### Comment 1
<location path="README.md" line_range="35-37" />
<code_context>
+
+The default mode. Communicates directly with Red Hat cloud services to upload inventory, download recommendations, and forward client requests.
+
+### IoP Mode (On-Premise)
+
+When an Insights on Premise (IoP) Smart Proxy is configured, all cloud communication is routed through the local proxy instead. HTTP proxy settings are disabled, and scheduled sync tasks are skipped.
+
+Check the current mode: `ForemanRhCloud.with_iop_smart_proxy?`
</code_context>
<issue_to_address>
**suggestion (typo):** Use the standard term "on-premises" instead of "on-premise/on Premise" for accuracy and consistency.

For example, update the heading to `IoP Mode (On-Premises)` and the sentence to `When an Insights on-premises (IoP) Smart Proxy is configured, ...` for consistent terminology.

```suggestion
### IoP Mode (On-Premises)

When an Insights on-premises (IoP) Smart Proxy is configured, all cloud communication is routed through the local proxy instead. HTTP proxy settings are disabled, and scheduled sync tasks are skipped.
```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[chris1984]

@nofaralfasi @jeremylenz feedback addressed

[nofaralfasi]

I'm unable to successfully run this command.
First run: Task d8fa0338... started, successfully moved the file from generated_reports/ to uploads/, but the rake command timed out waiting for the upload to Red Hat cloud to finish.
Second run: Failed with ENOENT because the file is no longer in generated_reports/ - the first task already moved it.