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

Consolidate Library READMEs with installation tutorials #14

Open
chapulina opened this issue Apr 29, 2020 · 5 comments
Open

Consolidate Library READMEs with installation tutorials #14

chapulina opened this issue Apr 29, 2020 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@chapulina
Copy link
Contributor

Some libraries have repeated content in their installation tutorials and READMEs
Choose one or the other for each library to have

@ahcorde
Copy link
Contributor

ahcorde commented Aug 13, 2020

Consolidated install documentation for the following libraries (Moved install instructions to the tutorials folder):

@ahcorde ahcorde self-assigned this Aug 13, 2020
@chapulina
Copy link
Contributor Author

Thanks for taking this on, @ahcorde !

I commented on one of the PRs, but for completeness I'll mention it here too that we should be linking to the published link of those installation tutorials, such as

https://ignitionrobotics.org/api/math/6.4/install.html

The reasons are:

@chapulina
Copy link
Contributor Author

Reopening as we're still missing some libraries:

@mabelzhang
Copy link
Contributor

The tutorials may not always render correctly on GitHub, their canonical location is on the ignitionrobotics.org site

I'm consolidating ign-common at the moment.

Do we want to keep the relative section links, e.g. the links to different types of installs under the Overview section here:

They don't jump correctly in the canonical location
https://ignitionrobotics.org/api/math/6.8/install.html#binary-install

But they jump correctly on GitHub
https://github.com/ignitionrobotics/ign-math/blob/ign-math6/tutorials/installation.md

@chapulina
Copy link
Contributor Author

Do we want to keep the relative section links

Yeah I recently noticed that too. I think we should remove them since they don't work on the main site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants