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

a way to consolidate documentation changes #800

Open
jmhodges opened this issue Dec 22, 2023 · 1 comment
Open

a way to consolidate documentation changes #800

jmhodges opened this issue Dec 22, 2023 · 1 comment
Labels
P3 An issue that we are not working on but will review quarterly

Comments

@jmhodges
Copy link

jmhodges commented Dec 22, 2023

In trying to figure out the current status of the strip_prefix = "." bugs (#354, #82), I noticed a documentation PR that adjusted the docs for strip_prefix in v0.8.0 but didn't do so in for v0.9.1 (PR in question). See the documentation site and specifically the v0.9.1 and v0.8.0 versions of the pkg_tar docs.

It'd be nice to have an automatic way for docs to get carried into new versions automatically. Or to generate docs from the skylark code itself.

(I'm not sure what the latest state of skylark-to-markdown generation is or anything. I'm just a normal user who was confused if 0.9.1 had changed the behavior of strip_prefix or something)

(Also, I got those documentation pages from the "Documentation" link the README.)

@aiuto
Copy link
Collaborator

aiuto commented Dec 22, 2023

The docs should be generated from the source. I'm not sure why the change to tar.bzl did not propagate through to the 0.9.1 generated docs. In #801 it seems to be there. That was built simply by running the doc generator.

I'm not sure what the latest state of skylark-to-markdown generation is or anything

Stardoc is missing a few critical pieces, so I post process around to those to produce rules_pkg docs.
It's a bit of a hack, and always lower priority than the core work of the package.

@aiuto aiuto added the P3 An issue that we are not working on but will review quarterly label Dec 22, 2023
cgrindel added a commit that referenced this issue Dec 22, 2023
They are stale, and looking into causes for #800
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P3 An issue that we are not working on but will review quarterly
Projects
None yet
Development

No branches or pull requests

2 participants