Skip to content

Fix howto docs#430

Merged
slyon merged 1 commit intocanonical:mainfrom
rkratky:FR-6139_fix-howtos
Jan 10, 2024
Merged

Fix howto docs#430
slyon merged 1 commit intocanonical:mainfrom
rkratky:FR-6139_fix-howtos

Conversation

@rkratky
Copy link
Contributor

@rkratky rkratky commented Dec 15, 2023 •
edited by atlassian bot
Loading

Description

This is a follow up to #429 -- don't merge before it.

Improve how-to docs:

  • Move intro to how-to landing page
  • Make headings consistently use "How to"
  • Remove (post-build) "How to" from TOC

Checklist

  • Runs make check successfully.
  • Retains 100% code coverage (make check-coverage).
  • N/A: New/changed keys in YAML format are documented.
  • N/A: (Optional) Adds example YAML for new feature.
  • (Optional) Closes an open bug in Launchpad. Fix FR-6139

@rkratky rkratky added enhancement New feature or request documentation Documentation improvements. labels Dec 15, 2023
@rkratky rkratky force-pushed the FR-6139_fix-howtos branch 5 times, most recently from 2d51a1d to b717269 Compare December 15, 2023 18:34
daniloegea
daniloegea reviewed Jan 3, 2024
View reviewed changes
Copy link
Contributor

@daniloegea daniloegea left a comment

Choose a reason for hiding this comment

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

Thanks, it looks good to me (only check the last commit).

@rkratky rkratky force-pushed the FR-6139_fix-howtos branch 2 times, most recently from 8442fc0 to d3288ec Compare January 3, 2024 15:26
slyon
slyon suggested changes Jan 4, 2024
View reviewed changes
Copy link
Contributor

@slyon slyon left a comment

Choose a reason for hiding this comment

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

Thanks, the changes are looking mostly good to me. But we hit some build failures. Locally, make run hits an endless loop and I see a failure on the readthedocs CI, which might be related to doc/howtos.sh being incomplete. (Some of which might already be fixed in #429)

I also left some inline comments.

@rkratky rkratky force-pushed the FR-6139_fix-howtos branch 4 times, most recently from ea19a30 to d1e859a Compare January 5, 2024 16:06
@rkratky
Copy link
Contributor Author

rkratky commented Jan 5, 2024

@slyon This is finally building successfully on RTD, so I believe it's good to merge (after #429).

@rkratky rkratky force-pushed the FR-6139_fix-howtos branch from d1e859a to 6b14164 Compare January 8, 2024 18:59
@rkratky
Copy link
Contributor Author

rkratky commented Jan 8, 2024

@slyon This is finally building successfully on RTD, so I believe it's good to merge (after #429).

Thanks, the changes are looking mostly good to me. But we hit some build failures. Locally, make run hits an endless loop and I see a failure on the readthedocs CI, which might be related to doc/howtos.sh being incomplete. (Some of which might already be fixed in #429)

I also left some inline comments.

Thanks. I was aware of those problems. Should be fixed now.

@slyon
Copy link
Contributor

slyon commented Jan 9, 2024

@rkratky Could you please rebase this branch on top of main, in order to resolve the merge conflicts?

@rkratky rkratky force-pushed the FR-6139_fix-howtos branch from 6b14164 to 4a1d1de Compare January 9, 2024 10:34
@rkratky
Copy link
Contributor Author

rkratky commented Jan 9, 2024

@rkratky Could you please rebase this branch on top of main, in order to resolve the merge conflicts?

Done. Sorry for the mess :)

slyon
slyon reviewed Jan 9, 2024
View reviewed changes
Copy link
Contributor

@slyon slyon left a comment

Choose a reason for hiding this comment

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

I guess we could squash both commits into "Improve how-to docs" (or I can do a squash merge). The first commit seems to be a left-over from the rebase.

Also see my inline comments for a few final nitpicks before we can merge this.

@rkratky rkratky force-pushed the FR-6139_fix-howtos branch from 4a1d1de to c595d47 Compare January 10, 2024 11:17
@rkratky
Improve how-to docs:
8c89668 
- Move intro to how-to landing page
- Make headings consistently use "How to"
- Remove (post-build) "How to" from TOC
@rkratky rkratky force-pushed the FR-6139_fix-howtos branch from c595d47 to 8c89668 Compare January 10, 2024 11:30
slyon
slyon approved these changes Jan 10, 2024
View reviewed changes
Copy link
Contributor

@slyon slyon left a comment

Choose a reason for hiding this comment

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

Thanks a lot for cleaning it all up! ❤️
LGTM.

@slyon slyon merged commit b44de52 into canonical:main Jan 10, 2024
@rkratky rkratky deleted the FR-6139_fix-howtos branch January 10, 2024 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@daniloegea daniloegea daniloegea left review comments

@slyon slyon slyon approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Documentation improvements. enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rkratky @slyon @daniloegea