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: addes subject and audit for the travel-plan project #2282

Merged
merged 8 commits into from
Jan 4, 2024

Conversation

zanninso
Copy link
Contributor

No description provided.

@nprimo nprimo self-requested a review November 16, 2023 11:01
Copy link
Contributor

@nprimo nprimo left a comment

Choose a reason for hiding this comment

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

I left some comments inline on what I think might require some improvements. I am happy to have a quick call if something needs to be discussed more in detail :)

@zanninso zanninso requested a review from nprimo November 28, 2023 01:43
Copy link
Contributor

@nprimo nprimo left a comment

Choose a reason for hiding this comment

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

I left some comments about changes that I feel are required to make the subject clearer.
Additionally, there are some minor grammar mistakes. I would recommend to use a plugin for grammar check in VSCode (or the editor you're using) or some CLI tools such as write-good or proselint

Copy link
Contributor

@nprimo nprimo left a comment

Choose a reason for hiding this comment

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

I left some comments inline.

Some old conversations have not been addressed: please, add a reaction to the conversation when you address them or add a comment about why you don't think we should implement the suggested changes.

There are quite some comments about capitalization - I left one comment per line to help keep track of which lines should be capitalized.

subjects/java/projects/travel-plan/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/audit/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/audit/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/audit/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/README.md Outdated Show resolved Hide resolved
@zanninso zanninso requested a review from nprimo December 19, 2023 00:44
Copy link
Contributor

@nprimo nprimo left a comment

Choose a reason for hiding this comment

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

As mentioned on Discord, please address the open conversation that does not have a reply or reaction linked to it to avoid stacking more comments/conversations on this PR

@zanninso zanninso requested a review from nprimo December 21, 2023 02:42
Copy link
Contributor

@nprimo nprimo left a comment

Choose a reason for hiding this comment

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

I left some comments in line to improve the clarity of some parts of the subject and audit.

I found two audit questions that ask for specific features that are not clearly defined in the subject (API Gateway and Logging system).

Additionally, it is mentioned to use the least privilege principle as a security measure and to use role-based access controls: isn't this supposed to be only for admin? Is it expected to have more than one level of access to the platform? This could create confusion in the audit phase of the project.

subjects/java/projects/travel-plan/audit/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/audit/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/audit/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/audit/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/audit/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/audit/README.md Outdated Show resolved Hide resolved
@zanninso zanninso requested a review from nprimo December 21, 2023 17:32
@nprimo nprimo self-requested a review December 21, 2023 19:13
Copy link
Contributor

@nprimo nprimo left a comment

Choose a reason for hiding this comment

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

I have added two minor change requests inline.

@zanninso it is mentioned to use the least privilege principle as a security measure and to use role-based access controls: isn't this supposed to be only for admin? Is it expected to have more than one level of access to the platform? This could create confusion in the audit phase of the project.

subjects/java/projects/travel-plan/audit/README.md Outdated Show resolved Hide resolved
subjects/java/projects/travel-plan/audit/README.md Outdated Show resolved Hide resolved
@zanninso zanninso requested a review from nprimo January 3, 2024 15:59
@nprimo
Copy link
Contributor

nprimo commented Jan 4, 2024

@zanninso as I have pointed out on Discord, could you please reply to this? As soon as this comment is addressed, we can approve and merge this PR :)

@zanninso
Copy link
Contributor Author

zanninso commented Jan 4, 2024

I have added two minor change requests inline.

@zanninso it is mentioned to use the least privilege principle as a security measure and to use role-based access controls: isn't this supposed to be only for admin? Is it expected to have more than one level of access to the platform? This could create confusion in the audit phase of the project.

I have added two minor change requests inline.

@zanninso it is mentioned to use the least privilege principle as a security measure and to use role-based access controls: isn't this supposed to be only for admin? Is it expected to have more than one level of access to the platform? This could create confusion in the audit phase of the project.

for this part of the project they will have just the admin role but in the final project they have to add more roles, it's already explained in subject. i don;t see that will make any confusion

Copy link
Contributor

@nprimo nprimo left a comment

Choose a reason for hiding this comment

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

LGTM

@zanninso zanninso merged commit 2b01036 into master Jan 4, 2024
2 checks passed
@zanninso zanninso deleted the CON-1783-MARKDOWN-Travel-Plan-Java-Project branch January 4, 2024 18:16
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