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

Fix some asciidoc cross-file links #2664

Merged
merged 19 commits into from
Oct 21, 2024

Conversation

jimklimov
Copy link
Member

@jimklimov jimklimov commented Oct 20, 2024

  • Fix the linkdoc macro in chunked-html (now that we generate chunk file names not numbered, but using their anchor name)
  • Add macros to wrap references to source files as such
    • Feels like more can be done here, e.g. for github rendering, or to refer to online version of that source from published docs
  • Allow a third argument to linkdoc and linksingledoc to generate a reference to file name in sources (for rapidly evolving ones)
  • Add a few samples for new use-cases in existing docs
    • If this seems like the way to do it, should be applied to countless other cases in docs sources
  • Fix older markup issues in older docs
  • Update resources used in NUT CI rendering (CSS)

…omizable Header plugin with DigitalOcean logo

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…include others (tracked in different repos)

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
… in indented lists

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…c and linksingledoc macros with optional reference to NUT source text document

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…doc and 3-argument linkdoc rendering

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…endering

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…: 4baaac1d4 (2024-10-20)

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…help with backslashes

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…refer to "link" macro anymore

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…rs becoming filenames)

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
...and use proper new extensions

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
@jimklimov jimklimov added documentation CI Entries related to continuous integration infrastructure (historically also recipes like Makefiles) labels Oct 20, 2024
@jimklimov jimklimov added this to the 2.8.3 milestone Oct 20, 2024
@AppVeyorBot

This comment was marked as resolved.

Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
@AppVeyorBot
Copy link

@jimklimov jimklimov merged commit 7429d23 into networkupstools:master Oct 21, 2024
9 of 10 checks passed
@jimklimov jimklimov deleted the fix-some-asciidoc branch October 21, 2024 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Entries related to continuous integration infrastructure (historically also recipes like Makefiles) documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants