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

README needs updates for links to docs #33027

Closed
robrap opened this issue Aug 16, 2023 · 4 comments
Closed

README needs updates for links to docs #33027

robrap opened this issue Aug 16, 2023 · 4 comments

Comments

@robrap
Copy link
Contributor

robrap commented Aug 16, 2023

The README is confusing at this time.

  1. There is no link to https://docs.openedx.org/projects/edx-platform/en/latest/index.html, which are the actual edx-platform docs. (Or at least I couldn't easily find one).
  2. There are lots of docs about the overall platform, and not about the specific repo. These docs should be minimized or moved or contained, so that if someone wants to learn about the larger platform, they can move on quickly to that information, and if they want to understand the repo, they have a more traditional README.

Note: The larger effort might take more time, so we may want to make a quick update to just add a link to edx-platform docs somewhere as a first step.

@feanil
Copy link
Contributor

feanil commented Sep 19, 2023

@robrap Given that #33047 covers point 2 and you made a PR that deal with point 1. I'm gonna close this ticket. Feel free to re-open if you think we missed something.

@feanil feanil closed this as completed Sep 19, 2023
@robrap
Copy link
Contributor Author

robrap commented Sep 19, 2023

@feanil: I still have a concern about the README, but #33281 is the quickest win I could think of to address it and close this ticket. Let me know what you think. We can re-close this when and if we land this PR, unless we need a deeper change.

@robrap robrap reopened this Sep 19, 2023
@feanil
Copy link
Contributor

feanil commented Sep 19, 2023

Sounds good. I approved that PR. I think that a major revamp of the README should update it to be compliant with the new standard set by the maintainership pilot

We could update this ticket to reflect that or create a new ticket for that.

@robrap
Copy link
Contributor Author

robrap commented Sep 19, 2023

We could update this ticket to reflect that or create a new ticket for that.

I think a new ticket would probably be cleaner at this point. The new ticket doesn't really need all this history. This ticket just addressed some quick-wins until that ticket is complete. I'll close this ticket. Feel free to open a new one whenever you wish. Thanks!

@robrap robrap closed this as completed Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

2 participants