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.

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

Remove outdated providers docs #999

Merged
merged 1 commit into from Oct 6, 2021
Merged

Conversation

alexjfisher
Copy link
Contributor

apipie-based providers (and the foreman_hostgroup type completely)
were removed in #663

This updates the README to reflect this.

README.md Outdated
Comment on lines 82 to 84
seen in _Administer > Settings_.

* `cli` provider uses `foreman-rake` to change settings (default)

`foreman_hostgroup` can create and manage host group in Foreman's database.
Providers:

* `rest_v2` provider uses API v2 with apipie-bindings and OAuth (default)
* `cli` provider uses `foreman-rake` to change settings
Copy link
Member

Choose a reason for hiding this comment

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

How about making it a nice flowing paragraph now that it's no longer a list?

Suggested change
seen in _Administer > Settings_.
* `cli` provider uses `foreman-rake` to change settings (default)
`foreman_hostgroup` can create and manage host group in Foreman's database.
Providers:
* `rest_v2` provider uses API v2 with apipie-bindings and OAuth (default)
* `cli` provider uses `foreman-rake` to change settings
seen in _Administer > Settings_. The `cli` provider uses `foreman-rake` to change settings.

Probably the same for foreman_smartproxy

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated. (I thought I'd pushed last night, but there'd been some network error and it hadn't made it out)

README.md Outdated

* `rest_v3` provider uses API v2 with Ruby HTTP library, OAuth and JSON (default)
* `rest_v2` provider uses API v2 with apipie-bindings and OAuth
Foreman's database. The `rest_v3` provider uses API v2 with Ruby HTTP library, OAuth and JSON
Copy link
Member

Choose a reason for hiding this comment

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

Clearly I wasn't paying attention yesterday. By now we've dropped API v1 so should we simplify it to

Suggested change
Foreman's database. The `rest_v3` provider uses API v2 with Ruby HTTP library, OAuth and JSON
Foreman's database. The `rest_v3` provider uses the API with Ruby's HTTP library, OAuth and JSON.

README.md Outdated
Providers:

* `rest_v2` provider uses API v2 with apipie-bindings and OAuth (default)
seen in _Administer > Settings_. The `cli` provider uses `foreman-rake` to change settings
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
seen in _Administer > Settings_. The `cli` provider uses `foreman-rake` to change settings
seen in _Administer > Settings_. The `cli` provider uses `foreman-rake` to change settings.

apipie-based providers (and the `foreman_hostgroup` type completely)
were removed in theforeman#663

This updates the README to reflect this.
Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

Thanks!

@ekohl ekohl merged commit c96237e into theforeman:master Oct 6, 2021
@ehelms ehelms added the Bug label Oct 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants