metal3-io / metal3-docs

Architecture documentation that describes the components being built under Metal³.
http://metal3.io
Apache License 2.0
267 stars 112 forks source link

User-guide: migrate configuration docs from BMO #316

Closed dtantsur closed 4 months ago

dtantsur commented 1 year ago

We need to have user-facing content in the user guide. The configuration should be a part of the installation guide, i.e. the missing "Install Baremetal Operator" page from https://book.metal3.io/bmo/introduction.html

Migrate from https://github.com/metal3-io/baremetal-operator/blob/main/docs/configuration.md https://github.com/metal3-io/baremetal-operator/blob/main/docs/ironic-authentication.md and https://github.com/metal3-io/baremetal-operator/blob/main/docs/deploying.md

/kind documentation /triage accepted /help

metal3-io-bot commented 1 year ago

@dtantsur: This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-help command.

In response to [this](https://github.com/metal3-io/metal3-docs/issues/316): >We need to have user-facing content in the user guide. The configuration should be a part of the installation guide, i.e. the missing "Install Baremetal Operator" page from https://book.metal3.io/bmo/introduction.html > >Migrate from https://github.com/metal3-io/baremetal-operator/blob/main/docs/configuration.md > >/kind documentation >/triage accepted >/help Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
adithyaakrishna commented 1 year ago

@dtantsur Can I take this up? If so, could you please give me a few more details?

dtantsur commented 1 year ago

@adithyaakrishna absolutely, unassigned bugs with "help wanted" are free to take.

Rozzii commented 1 year ago

/good-first-issue

metal3-io-bot commented 1 year ago

@Rozzii: This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-good-first-issue command.

In response to [this](https://github.com/metal3-io/metal3-docs/issues/316): >/good-first-issue Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
metal3-io-bot commented 1 year ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues will close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle stale

Rozzii commented 1 year ago

/remove-lifecycle stale

wrkode commented 1 year ago

@dtantsur, I'm working on this issue, I already have a local environment and I'm working on the Install page. Do I understand correctly that the desire is to have the Install Baremetal Page, hosting the full content of: configuration.md ironic-authentication.md deploying.md

if the understanding is correct, I have created https://github.com/metal3-io/metal3-docs/pull/352 and added wrapping wording.

disclaimer: this is my first contribution, so please be patient :)

wrkode commented 1 year ago

@dtantsur I believe this issue can be closed as #352 got merged.

metal3-io-bot commented 10 months ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues will close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle stale

Rozzii commented 10 months ago

@dtantsur Are you fine with the current state of the docs , do we need to move anything else around or can we close this ?

Rozzii commented 9 months ago

/remove-lifecycle stale

dtantsur commented 9 months ago

I believe we should remove the docs from the BMO repo now so that they don't diverge. Any objections?

Rozzii commented 9 months ago

I believe we should remove the docs from the BMO repo now so that they don't diverge. Any objections?

No Objections I am happy to do it.

Rozzii commented 8 months ago

/assign @Rozzii

Rozzii commented 8 months ago

/remove help

metal3-io-bot commented 5 months ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues will close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle stale

Rozzii commented 5 months ago

/remove-lifecycle stale I have to check this not sure about the status

wrkode commented 5 months ago

/remove-lifecycle stale I have to check this not sure about the status

@Rozzii, I've completed this via #352 which got merged, but the issue was never closed

Rozzii commented 4 months ago

thanks @wrkode , then I will close this ticket