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

Add quality requirements for AppCat #16

Merged
merged 7 commits into from
Mar 16, 2022
Merged

Add quality requirements for AppCat #16

merged 7 commits into from
Mar 16, 2022

Conversation

Kidswiss
Copy link
Contributor

@Kidswiss Kidswiss commented Mar 10, 2022

Adds various quality requirements to the AppCat Framework.

Format is inspired by https://github.com/appuio/appuio-io-docs/

@Kidswiss Kidswiss requested a review from tobru March 10, 2022 11:58
Copy link
Contributor

@ccremer ccremer left a comment

Choose a reason for hiding this comment

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

Overall a good starting point 👍
This PR has gotten very large and I didn't fully review it yet.
Might consider splitting it up in some way.

Reading through it could roughly group the requirements into 2 categories:

  • The ones targeting the AppCat as a Framework itself to establish a base standard. (e.g. some in usability or regarding monitoring)
  • The ones that are try to dictate how services themselves should behave or be engineered. (e.g. security, performance)

I think it's better to only list the ones directly applicable for the framework. And then each service should be treated independently including things like security or performance aspects.

docs/modules/ROOT/pages/reference/quality-functional.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/reference/quality-functional.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/reference/quality-functional.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/reference/quality-functional.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/reference/quality-functional.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/reference/quality-reliability.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/reference/quality-security.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/reference/quality-security.adoc Outdated Show resolved Hide resolved
docs/modules/ROOT/pages/reference/quality-usability.adoc Outdated Show resolved Hide resolved
@ccremer
Copy link
Contributor

ccremer commented Mar 15, 2022

I feel these discussions are somewhat inefficient but very important. Let's make a call to discuss the details and then do some pair programming to get this done.

@Kidswiss Kidswiss force-pushed the qr branch 2 times, most recently from 5a38616 to 78834d6 Compare March 15, 2022 12:12
@Kidswiss
Copy link
Contributor Author

I've rephrased the points that were still open. We can take that as a starting point for a call.

@ccremer
Copy link
Contributor

ccremer commented Mar 15, 2022

@Kidswiss and I had a call to flesh out duplicates and things that are better left documented in the future service development guide. This PR got smaller and more structured.

Vale complains again
@ccremer ccremer changed the title Add quality requirements for appcat Add quality requirements for AppCat Mar 16, 2022
@ccremer ccremer added the requirement/quality Quality or non-functional requirement label Mar 16, 2022
@Kidswiss Kidswiss merged commit 185a639 into master Mar 16, 2022
@Kidswiss Kidswiss deleted the qr branch March 16, 2022 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
requirement/quality Quality or non-functional requirement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants