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

New repo/structure for AsciiDocsy docs deployment once theme is gem? #65

Open
briandominick opened this issue Jul 24, 2021 · 0 comments
Labels
CI/CD Jekyll Involves working heavily with or extending Jekyll SSG Ruby Involves some Ruby troubleshooting/coding
Milestone

Comments

@briandominick
Copy link
Contributor

For the 3.0 release, in which AsciiDocsy will be packaged as a Ruby gem (#31), we will want the AsciiDocsy docs themselves (the documentation that covers the AsciIDocsy theme), to not be based in the root dir of any Jeklyll application using this theme.

For any use of the theme gem, including AsciiDocsy docs's own use, we want the application root to be definitional and for everything in it to override. So we either need to clean up the directory structure and have a distinct Jekyll application inside the gem file structure, or we need to separate the docs out and have a distinct repo use the the way any other application would. This has the advantage of demonstrating a relatively organic use of the theme. Unfortunately, it means another repo, and I think a self-documenting gem is really what's called for, so we'll probably just have a docs/ dir that can be used for Jekyll executions against the content inside it, with a _config.yml file there that does not interfere with the config for an app that might call the gem.

@briandominick briandominick added CI/CD Jekyll Involves working heavily with or extending Jekyll SSG Ruby Involves some Ruby troubleshooting/coding labels Jul 24, 2021
@briandominick briandominick added this to the 0.3.0 milestone Jul 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Jekyll Involves working heavily with or extending Jekyll SSG Ruby Involves some Ruby troubleshooting/coding
Projects
None yet
Development

No branches or pull requests

1 participant