docs: Update how to access oppia webpages#520
Conversation
Updated descriptions and permissions for various pages in the Oppia documentation, including user account, admin, static, collection, exploration, topics and skills, and contributor pages.
HardikGoyal2003
left a comment
HardikGoyal2003
left a comment
There was a problem hiding this comment.
@riyaseema80 Thanks a lot for the PR. I have reviewed it till super-admins part and left a few comments. Once you fix them, feel free to ask for another review.
|
Hi @HardikGoyal2003 I’ve addressed the requested changes and updated the document accordingly. Please let me know if anything else needs to be modified. Thanks! |
HardikGoyal2003
left a comment
HardikGoyal2003
left a comment
There was a problem hiding this comment.
@riyaseema80 Left a few comments. Can you also arrange the content inside Oppia Webpages and Public informational pages in lexicographical order?
|
@HardikGoyal2003 Thanks for the review! I’ve addressed the new comments — removed the line, updated the super admin description, formatted the pages as suggested, and arranged the sections in lexicographical order. Please take another look when you have time. |
Correct capitalization in headings and steps for consistency throughout the document.
|
Hi @HardikGoyal2003, I’ve updated the Steps to Access formatting across the document based on your suggestion. Please let me know if it looks correct or if any further changes are needed. Thanks! |
There was a problem hiding this comment.
Left a few more comments: A few things to fix are:
- Pages that have tabs should follow this format in the lexicographical order (Note: You don't need to add tabs in the table of contents. Adding `Important admin page tabs`` is sufficient)
- Make the Tab names proper across the docs. For eg: Tab name is
Roles Tabbut you have named it asAssign Roles, so fix this across the docs. - In the permissions required, you have mentioned
super-admin only. Update it to[Super Admin](https://github.com/oppia/oppia-web-developer-docs/blob/df4319b52bf61b4aa33a2944903bfa3bea1b9544/How-to-access-Oppia-webpages.md#log-in-as-a-super-administrator)
|
Thanks for the detailed feedback! I have updated all tab sections to follow the same format, ensure they are arranged in lexicographical order, fix tab naming consistency across the document, and update permissions to use the Super Admin reference. |
|
Hi @HardikGoyal2003, I’ve updated the doc structure as suggested. |
HardikGoyal2003
left a comment
HardikGoyal2003
left a comment
There was a problem hiding this comment.
I have completed a review till the exploration editor page.
|
i have improved page descriptions, fixed routes, and added data generation steps for pages. Thanks! |
… and data generation steps
|
Hi @HardikGoyal2003, |
There was a problem hiding this comment.
- Can you please fix the formatting of the table of contents?
- Can you also fix the formatting for the manual steps in populating data, like: #520 (comment)
|
Hi, I’ve updated the formatting for the manual steps as suggested. |
HardikGoyal2003
left a comment
HardikGoyal2003
left a comment
There was a problem hiding this comment.
@riyaseema80 Awesome work, a few minor comments left, PTAL. Also, remove these pages now:
- https://github.com/oppia/oppia/wiki/Populating-data-on-local-server
- https://github.com/oppia/oppia/wiki/LaCE-onboarding-guide
- These headings from the wiki sidebar too
|
Hi @HardikGoyal2003, thank you! I've added the quick method for contributor dashboard. Please take a look when you get a chance. |
|
@riyaseema80 Can you please check this comment too: #520 (review) |
|
Hi @HardikGoyal2003 , I've deleted the two pages (Populating-data-on-local-server and LaCE-onboarding-guide), but I don't have permission to edit the wiki sidebar. |
|
@riyaseema80 You need to update this file: https://github.com/oppia/oppia-web-developer-docs/blob/develop/_Sidebar.md |
|
Hi @HardikGoyal2003 , I’ve updated the _Sidebar.md file and removed the requested entries. Please let me know if anything else is needed. Thanks! |
HardikGoyal2003
left a comment
HardikGoyal2003
left a comment
There was a problem hiding this comment.
Thanks @riyaseema80 for working on this. LGTM.
|
Thanks for the review! |
|
Hi @HardikGoyal2003, Please let me know if anything else is needed from my side. Thanks! |
|
Thanks for the review and merge! |
3 participants
Overview
This PR adds a comprehensive Oppia Dev Server Guide to help contributors understand how to navigate and use the local development environment.
The guide documents the major pages, dashboards, routes, and workflows available in Oppia, and provides screenshots and step-by-step instructions for common tasks.
What this PR includes
Why this is useful
This documentation helps:
Testing
Screenshots
Multiple screenshots have been added to illustrate important pages such as:
Fix Issue :#477