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

Documentation: A few more updates #18

Merged
merged 3 commits into from
Mar 29, 2023
Merged

Documentation: A few more updates #18

merged 3 commits into from
Mar 29, 2023

Conversation

amotl
Copy link
Member

@amotl amotl commented Mar 28, 2023

This patch is a little follow-up to GH-17, in order to:

  • Update the "About" section within the README once more.
  • Add a backlog file, to keep track of todo items and ideas.

The rendered version of the documents can be inspected at the updated README and the backlog.

@amotl amotl requested review from matriv and hlcianfagna March 28, 2023 20:30
doc/backlog.rst Outdated
Copy link
Member Author

@amotl amotl Mar 28, 2023

Choose a reason for hiding this comment

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

@matriv: Let me know if you would like to have some items listed in the backlog.rst file to be converged into issues already. In general, I think it will be fine to pick them from here, but one or another item may deserve better visibility.

Copy link
Contributor

@matriv matriv Mar 29, 2023

Choose a reason for hiding this comment

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

It looks very good, but why not have an open issue instead of a committed backlog file?
I'm afraid with the backlog file it can get more easily forgotten in the future, wdyt?

Copy link
Member Author

@amotl amotl Mar 29, 2023

Choose a reason for hiding this comment

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

In general, I agree. But I don't want to create single issues for each and every of those items yet. We may identify and refactor important ones into dedicated issues, and let the rest sit in the backlog file, or link them into a bundle/meta-issue.

My main intention was to write down notes what could be worked on in the future. If you think we should just put all that content into a single public issue, with bullet points, I will also be happy to do it.

Copy link
Member Author

@amotl amotl Mar 29, 2023

Choose a reason for hiding this comment

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

I think, because "General » Next steps" will go away anyway soon, there would be three dedicated issues to create, when following the "bundling approach" - one for each of:

  • General » Actionable
  • General » Research
  • Cloud readiness

That would be acceptable. WDYT?

Copy link
Member Author

@amotl amotl Mar 29, 2023

Choose a reason for hiding this comment

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

I've dissolved the backlog file again with 67c4294, and created three bundle issues, as outlined above. Individual items may become dedicated issues, based on priority or urgency.

Copy link
Contributor

Choose a reason for hiding this comment

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

Excellent, thank you!

@amotl amotl marked this pull request as ready for review March 28, 2023 20:33
@amotl amotl changed the title Documentation: Update "About" section in README once more Documentation: A few more updates Mar 28, 2023
@amotl amotl force-pushed the amo/more-docs branch 2 times, most recently from d7073bc to 71e0ad6 Compare March 28, 2023 21:43
Base automatically changed from amo/improve-docs to main March 29, 2023 23:01
@amotl amotl merged commit 0a3dc54 into main Mar 29, 2023
@amotl amotl deleted the amo/more-docs branch March 29, 2023 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants