-
Notifications
You must be signed in to change notification settings - Fork 27
documentation for observer-access #54
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
base: main
Are you sure you want to change the base?
Conversation
feat : new property of observer-access added for read only access
✅ Deploy Preview for ontrackdocumentation ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
lachlan-robinson
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @SyedaLamiaTabassum, well done on this documentation task.
Well done:
- The documentation clearly explains the purpose and implementation of the Observer role, including its read-only policy.
- Sections are logically organized: Overview, Implementation, Database Changes, Code Logic, Unit Tests, and Conclusion.
- Code snippets for migration, authorization logic, and unit tests are provided, making it easy for developers to understand and replicate.
Consider changes:
- Minor typos (e.g., "utfmb3" should be "utf8mb3")—ensure terminology matches actual code/database settings.
- Consider using bullet points or numbered lists for steps and actions for easier readability.
This documentation is thorough and professional, providing all necessary details for understanding and maintaining the Observer role in the Doubtfire API. Minor formatting and consistency improvements could further enhance clarity.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well done on implementing the requested changes to the documentation. However,
- Your PR is not currently passing the automated build actions.
Make sure that:
- You have branched from the latest main branch that does not have build errors.
- You have tested your doubtfire-astro branch locally using
npm startto ensure it builds without errors.
Hello, I have tested my branch locally and the build is working now, |
WaelAlahamdi
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @SyedaLamiaTabassum, I have reviewed the documentation and found no issues. Everything looks clear and well-structured. Thank you for the work.
Description
new role of observer-access has been added that will provide read only access to specified user.
Type of change
Checklist
astro.config.mjs