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

docs: unify app wiring documentation #12340

Merged
merged 4 commits into from
Jun 29, 2022
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jun 23, 2022

Description

Generalize the documentation of app wiring between modules.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@@ -0,0 +1,5 @@
# App Wiring
Copy link
Member

Choose a reason for hiding this comment

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

will this be expanded? not sure it needs its own file, not entirely sure why it was added to the docs as well?

Copy link
Member Author

@julienrbrt julienrbrt Jun 23, 2022

Choose a reason for hiding this comment

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

I actually added it in every PR, I thought it might help if you want to have an app with only specific modules. You tell me if not needed, we can use this PR to remove from everywhere.

Copy link
Member

Choose a reason for hiding this comment

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

I could be wrong, but this is related to how testing will be done which will have its own documentation. Right now the spec describes module specific designs.

Would a user need to look at this file? trying to better understand when someone would look at it

Copy link
Member Author

@julienrbrt julienrbrt Jun 23, 2022

Choose a reason for hiding this comment

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

What will be the content of these files, I guess, still can be defined. Maybe it should be under Building Modules instead, I have not put much thought into it. I do think we should mention it in the documentation, as it shows what are the dependencies of a module (that's why I thought specs was a good place).

@julienrbrt julienrbrt changed the base branch from main to epic/app-wiring June 29, 2022 13:41
@julienrbrt julienrbrt merged commit 1194321 into epic/app-wiring Jun 29, 2022
@julienrbrt julienrbrt deleted the julien/app-wiring-docs branch June 29, 2022 14:12
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.

2 participants