This is an archive of the discontinued LLVM Phabricator instance.

[libc++] [docs] Migrate C++ status pages to RestructuredText (RST).
ClosedPublic

Authored by curdeius on Nov 24 2020, 11:51 PM.

Details

Summary

Currently, papers and issues are in separate .csv files (that is easier to update), but I can put them inline.Transforming current html tables into rst are done by the script (attached to the patch FYI but I'll remove it before committing).
I'll of course update RST files before committing to match any modifications that may happen in master branch.

This patch moves the status pages in www/ to RST format in docs/.

It also does some other minor changes: fix copyright year and broken comment end, adds substitutions for coherence (and add colors, but that can be removed easily).
It adds as well redirects from old to new status pages.

Diff Detail

Event Timeline

curdeius created this revision.Nov 24 2020, 11:51 PM
Herald added a reviewer: jfb. · View Herald Transcript
Herald added a project: Restricted Project. · View Herald Transcript
Herald added a reviewer: Restricted Project. · View Herald Transcript
curdeius requested review of this revision.Nov 24 2020, 11:51 PM
curdeius retitled this revision from [libc++] [www] Migrate C++ status pages to RestructuredText (RST). Currently, papers and issues are in separate .csv files (that is easier to update), but I can put them inline. Transforming current html tables into rst are done by the script... to [libc++] [www] Migrate C++ status pages to RestructuredText (RST)..Nov 24 2020, 11:53 PM
curdeius edited the summary of this revision. (Show Details)
curdeius edited the summary of this revision. (Show Details)

Just thinking out loud, would it be a good idea to add documentation artifacts to BuildKite?
I mean changing buildkite-pipeline.yml:

- label: "Documentation"
  command: "libcxx/utils/ci/run-buildbot documentation"
  artifact_paths:
    - "**/test-results.xml"
    - "projects/libcxx/docs/html/**/*" # <<<<<<<<<<<<<<<< added
ldionne accepted this revision.Nov 25 2020, 11:56 AM

Just thinking out loud, would it be a good idea to add documentation artifacts to BuildKite?

What would we do with those? I'm not sure what's the setup that currently causes libcxx.llvm.org to be updated. Are you suggesting we tie those together?

I really like this change! I think we should try to move all of our documentation to the same format (rst or anything else we like, and rst seems fine). I've been meaning to do this for a long time, but it never was sufficiently high on my priority list. Thanks for doing this!

I didn't check that your script transcribed all papers correctly, but I trust it does. LGTM if you remove the transition script.

This revision is now accepted and ready to land.Nov 25 2020, 11:56 AM
curdeius retitled this revision from [libc++] [www] Migrate C++ status pages to RestructuredText (RST). to [libc++] [docs] Migrate C++ status pages to RestructuredText (RST)..Nov 26 2020, 1:00 AM

Just thinking out loud, would it be a good idea to add documentation artifacts to BuildKite?

What would we do with those? I'm not sure what's the setup that currently causes libcxx.llvm.org to be updated. Are you suggesting we tie those together?

I don't know either what updates the doc on the site. Anyway, I just thought that could be nice to have it, but anyone that does substantial changes to docs would anyway run make docs-libcxx-html.

I didn't check that your script transcribed all papers correctly, but I trust it does. LGTM if you remove the transition script.

I double-checked that.

And I removed the script.