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

Documentation: Initial pandoc conversion #1586

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

yadij
Copy link
Contributor

@yadij yadij commented Nov 15, 2023

Add pandoc tools dependency to Squid.

Initial documentation file conversion to Markdown
see https://github.github.com/gfm/ for syntax.

Also, updated and polished the squid.8 content to
comply better with manual practices and Squid
current features / behaviours.

@yadij yadij marked this pull request as draft November 15, 2023 19:08
src/Makefile.am Outdated Show resolved Hide resolved
src/squid.md.in Outdated Show resolved Hide resolved
src/squid.md.in Outdated Show resolved Hide resolved
src/squid.md.in Outdated Show resolved Hide resolved
src/squid.md.in Outdated Show resolved Hide resolved
src/squid.md.in Outdated Show resolved Hide resolved
src/squid.md.in Outdated Show resolved Hide resolved
src/Makefile.am Outdated Show resolved Hide resolved
@yadij yadij requested a review from rousskov November 17, 2023 12:09
@yadij yadij marked this pull request as ready for review November 17, 2023 12:09
src/squid.md Show resolved Hide resolved
@yadij yadij added the S-waiting-for-reviewer ready for review: Set this when requesting a (re)review using GitHub PR Reviewers box label Nov 17, 2023
@yadij yadij requested a review from kinkie November 17, 2023 12:15
src/squid.md Outdated Show resolved Hide resolved
doc/manuals/Substitute.am Show resolved Hide resolved
@rousskov rousskov added S-waiting-for-author author action is expected (and usually required) S-waiting-for-reviewer ready for review: Set this when requesting a (re)review using GitHub PR Reviewers box and removed S-waiting-for-reviewer ready for review: Set this when requesting a (re)review using GitHub PR Reviewers box labels Nov 20, 2023
@yadij yadij removed the S-waiting-for-author author action is expected (and usually required) label Nov 27, 2023
@yadij yadij requested a review from rousskov November 27, 2023 09:56
doc/manuals/Substitute.am Show resolved Hide resolved
@kinkie
Copy link
Contributor

kinkie commented Dec 12, 2023

I would support GFM as a dialect; it has powerful backing and should be strict enough that we wouldn't end up in the situation we had with the wiki. I expect that all that's needed to adopt it is to change the argument to pandoc, so no need to redo translation work.

@yadij , can you agree to this?

@rousskov rousskov added the S-waiting-for-more-authors needs developer help label Dec 12, 2023
@yadij yadij requested a review from rousskov December 17, 2023 18:49
@yadij yadij removed the S-waiting-for-more-authors needs developer help label Dec 17, 2023
@yadij

This comment was marked as resolved.

@kinkie

This comment was marked as outdated.

@kinkie

This comment was marked as resolved.

@kinkie

This comment was marked as resolved.

@rousskov

This comment was marked as outdated.

@kinkie

This comment was marked as outdated.

@kinkie

This comment was marked as outdated.

@squid-anubis squid-anubis added M-failed-other https://github.com/measurement-factory/anubis#pull-request-labels and removed M-failed-other https://github.com/measurement-factory/anubis#pull-request-labels labels Jan 9, 2024
@yadij yadij closed this Jan 22, 2024
@yadij yadij reopened this Jan 22, 2024
@kinkie
Copy link
Contributor

kinkie commented Jan 22, 2024

Currently, the biggest missing/unknown piece of information for me here is whether gfm supports metadata blocks

gfm supports - in fact, requires to be practically used - metadata in the form of Front Matter

@rousskov
Copy link
Contributor

Reviewer insists that we select a final and permanent Markdown syntax up-front and only use that one syntax forever, in all places Squid can or may now or in future utilize Markdown.

Nobody insists on (or even suggests) that.

src/squid.md Outdated Show resolved Hide resolved
@yadij yadij changed the title Docs: Initial pandoc conversion Documentation: Initial pandoc conversion Jan 25, 2024
@thesamesam

This comment was marked as resolved.

kinkie
kinkie previously approved these changes Feb 19, 2024
Copy link
Contributor

@kinkie kinkie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested this; it works. Thanks!

@yadij yadij added S-waiting-for-QA QA team action is needed (and usually required) M-ignored-by-merge-bots https://github.com/measurement-factory/anubis/blob/master/README.md#pull-request-labels and removed S-waiting-for-reviewer ready for review: Set this when requesting a (re)review using GitHub PR Reviewers box labels Feb 25, 2024
@yadij yadij requested a review from rousskov November 10, 2024 10:28
@yadij yadij added S-waiting-for-reviewer ready for review: Set this when requesting a (re)review using GitHub PR Reviewers box and removed S-waiting-for-QA QA team action is needed (and usually required) M-ignored-by-merge-bots https://github.com/measurement-factory/anubis/blob/master/README.md#pull-request-labels labels Nov 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-for-reviewer ready for review: Set this when requesting a (re)review using GitHub PR Reviewers box
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants