docs icon indicating copy to clipboard operation
docs copied to clipboard

Task - check if ability to create repo for 'personal' git org requires any documentation update

Open GreenMachine01 opened this issue 2 years ago • 3 comments

See - https://github.com/amplication/amplication/issues/5854 Check and execute if it should be mentioned in the docs

GreenMachine01 avatar May 30 '23 09:05 GreenMachine01

@GreenMachine01, we should update the documentation in at least 2 pages and there are also some edge cases that should be documented.

Edge Cases

  1. When the user sees the Internal Server Error message. What should they do?

Image

  1. If the user configures Amplication such that it can only access selected repositories. Even if they create a new repository it won't show up, so it's necessary to let them know to re-configure Amplication so that they can select that repository.

Image

We can document these edge cases in a new GitHub-focused Troubleshooting page. We can link to this troubleshooting page from the pages that mention connecting to GitHub.

Pages That Need Updates:

  1. Sync With GitHub - Set Amplication's Configuration Settings Section
  2. Create Your First Service - Connect Your GitHub Repository Section

What are your thoughts?

CC: @mulygottlieb

dericksozo avatar Jul 06 '23 10:07 dericksozo

@dericksozo The error only happens when you removed Amplication from the repo but we dont know about it and try to access the org. We have an issue to fix it - https://github.com/amplication/amplication/issues/4957

GreenMachine01 avatar Jul 12 '23 13:07 GreenMachine01

@GreenMachine01, the updates for this task are included in #330.

dericksozo avatar Aug 06 '23 16:08 dericksozo