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

Explore alternatives to Antora for documentation #650

Open
3 tasks
NickLarsenNZ opened this issue Aug 15, 2024 · 3 comments
Open
3 tasks

Explore alternatives to Antora for documentation #650

NickLarsenNZ opened this issue Aug 15, 2024 · 3 comments

Comments

@NickLarsenNZ
Copy link
Member

Important

This issue is not a commitment to replacing Antora. It is just to record the frustrations of the current documentation workflow, look into alternatives, do timeboxed trials, and understand what we then lose by switching.

Acceptance

  • List shortcomings of the status-quo (Antora)
  • List things we like about the status-quo (Antora)
  • Timeboxed trial of select alternatives to understand the tradeoffs
@fhennig
Copy link
Contributor

fhennig commented Aug 15, 2024

thanks for creating this issue, I have already taken some notes on the things you mention in the past, see this nuclino page for reference: https://app.nuclino.com/Stackable/Engineering/Why-Antora-WIP-4e7d2405-d938-4b70-b2a4-0314faafeffd

Anyone tackling this: I would suggest to expand the document so we have it all in once place and the Knowledge base seems like a good place for this info

also definitely in favor of hands-on trials of other tools and timeboxing also a good idea!

@NickLarsenNZ
Copy link
Member Author

NickLarsenNZ commented Aug 15, 2024

I think Nuclino makes it hard to discuss it async (as we think of things that could conflict with existing content). Also the openness is nice :)

Either way, this is the issue to track the exploration (so we can get it on the board at some point).

@fhennig
Copy link
Contributor

fhennig commented Aug 15, 2024

Alright, i thought it could be a useful format. you can also comment on the document in nuclino if you have specific thoughts of where you disagree! Otherwise my notes can just serve as one reference point I guess :) But I think the final result should include lists in nuclino for reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants