docs icon indicating copy to clipboard operation
docs copied to clipboard

libs: Include SDFormat in web page?

Open EricCousineau-TRI opened this issue 5 years ago • 5 comments

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 avatar Jun 02 '20 02:06 EricCousineau-TRI

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 :slightly_smiling_face:

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 avatar Jun 02 '20 02:06 chapulina

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

ahcorde avatar Aug 18 '20 11:08 ahcorde

Fix has been merged but not deployed

scpeters avatar Aug 24 '20 18:08 scpeters

Current status:

  • SDF listed on these pages:
    • https://ignitionrobotics.org/docs
    • https://ignitionrobotics.org/libs
  • README / Changelog rendered on this entry page: https://ignitionrobotics.org/libs/sdformat
  • Links to source code correctly point to https://github.com/osrf/sdformat
  • API doc links are currently broken, for example: https://ignitionrobotics.org/api/sdformat/8.0/index.html
    • [ ] These links should point to libSDFormat's own API docs, e.g. http://osrf-distributions.s3.amazonaws.com/sdformat/api/8.2.0/index.html

chapulina avatar Nov 16 '20 16:11 chapulina

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 https://github.com/osrf/sdformat/issues/527

chapulina avatar Mar 31 '21 00:03 chapulina