oppia / oppia-web-developer-docs

Repo for Web developer documentation on Oppia. For contribution instructions, see: https://github.com/oppia/oppia/wiki/Wiki#contributing-to-the-wiki
Apache License 2.0
10 stars 94 forks source link

Create team overview pages #28

Open Nik-09 opened 2 years ago

Nik-09 commented 2 years ago

Add the getting-started pages for the following two pages of Oppia. The pages should contain similarly detailed information as we have for the contributor dashboard.

seanlip commented 1 year ago

Per discussion with @nithinrdy, maybe the correct entry point for this is through the per-team getting-started pages -- here's the one for Contributor Dashboard, and we might want similar ones for the other two teams, LaCE and dev workflow.

Nik-09 commented 1 year ago

Per discussion with @nithinrdy, maybe the correct entry point for this is through the per-team getting-started pages -- here's the one for Contributor Dashboard, and we might want similar ones for the other two teams, LaCE and dev workflow.

I have updated the description as per the comment.

seanlip commented 1 year ago

Hi @Nik-09 -- @SanjaySajuJacob has actually prepared this doc for LaCE onboarding: https://github.com/oppia/oppia/wiki/LaCE-onboarding-guide. Do you think it is sufficient for this issue?

Also @U8NWXD @gp201 @JeeveshGarg @Shivkant-Chauhan do you want to make a similar doc for folks onboarding to the dev workflow team? I'm not sure what should go on it, so checking to see if there are any common issues that arise for new contributors (or contributors starting a project in a new domain) that you're aware of. Possibly even a list of links to the relevant wiki pages might be helpful (e.g. "If you're working on XYZ, look at ABC").

Nik-09 commented 1 year ago

Hi @Nik-09 -- @SanjaySajuJacob has actually prepared this doc for LaCE onboarding: https://github.com/oppia/oppia/wiki/LaCE-onboarding-guide. Do you think it is sufficient for this issue?

Yes, the page is very effective; I think adding an overview section for the LaCE team will be better.

seanlip commented 1 year ago

Thanks @Nik-09 for the suggestion! Added to #156.

Also @U8NWXD @gp201 @JeeveshGarg @Shivkant-Chauhan, just a friendly ping on https://github.com/oppia/oppia-web-developer-docs/issues/28#issuecomment-1506600546 -- thanks!

U8NWXD commented 1 year ago

@seanlip I can't think of any common issues that we don't already have docs for. Right now we're spread over a pretty broad range of projects, so we might have more use for a centralized page once we're all working on more similar tasks

seanlip commented 1 year ago

@U8NWXD OK, but in that case, what do you think about a "Welcome to the Dev Workflow Team" page that lists the broad areas and points to the relevant wiki pages for each? Then we have a getting started page for each team, which we can perhaps include in the emails we send folks when inviting them to a team (or in the getting started page).

(Just double-checking this point since your comment didn't address it directly; if you still don't want it, then that's fine!)

U8NWXD commented 1 year ago

I think that could be useful. Here are the pages I can think of to link: