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

libs: Include SDFormat in web page? #32

Open
EricCousineau-TRI opened this issue Jun 2, 2020 · 5 comments
Open

libs: Include SDFormat in web page? #32

EricCousineau-TRI opened this issue Jun 2, 2020 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation infrastructure Requires changes on the web server or other infra

Comments

@EricCousineau-TRI
Copy link

For this page: https://ignitionrobotics.org/libs
Is it possible (or does it make sense) to include SDFormat too? (or something like "Parsing", "Modeling", "Modeling Formats", ...?)

FTR This seems to be more comprehensive (but lower level?):
https://github.com/ignitionrobotics/docs/blob/198e1f957195cb38945f352dc136076052f7db82/contributing.md#repository-list

(Stemming off of this post: https://community.gazebosim.org/t/gsod-2020-ignition-robotics-on-boarding-guide/576/2?u=ericcousineau-tri )

@EricCousineau-TRI EricCousineau-TRI changed the title libs: Include SDFormat? libs: Include SDFormat in web page? Jun 2, 2020
@chapulina
Copy link
Contributor

Yeah these are good questions. Given that SDF is older than Ignition, the approach we've been taking has been to treat it as not a sibling but an older cousin. So, still part of the family 🙂

Sticking with that approach, I guess it would make sense to keep all SDFormat documentation in https://sdformat.org, and link to that from the libs page. That may need some custom code on the website's server.

@chapulina chapulina added the documentation Improvements or additions to documentation label Jun 5, 2020
@chapulina chapulina added the infrastructure Requires changes on the web server or other infra label Jun 5, 2020
@ahcorde
Copy link
Contributor

ahcorde commented Aug 18, 2020

@nkoenig I created a PR in the backend. Do you mind to have a look?

@scpeters
Copy link
Member

Fix has been merged but not deployed

@chapulina
Copy link
Contributor

Current status:

@chapulina
Copy link
Contributor

chapulina commented Mar 31, 2021

We could also add SDFormat to the API doc upload script, which is used in the nightly doc uploads.

Here's SDFormat's own upload docs script.

Related to gazebosim/sdformat#527

@azeey azeey moved this to In progress in Core development Jul 24, 2023
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 infrastructure Requires changes on the web server or other infra
Projects
Status: In progress
Development

No branches or pull requests

5 participants