Add Gradle Plugin docs - Githubissues

asciidoctor / docs.asciidoctor.org

The Antora playbook project (i.e., site manifest) for the Asciidoctor documentation site.

https://docs.asciidoctor.org

MIT License

14 stars 18 forks source link

Add Gradle Plugin docs #66

Closed abelsromero closed 7 months ago

abelsromero commented 3 years ago

~This is for preview from the forked branch linked to PR https://github.com/asciidoctor/asciidoctor-gradle-plugin/pull/601~

Updated to new PR https://github.com/asciidoctor/asciidoctor-gradle-plugin/pull/722

abelsromero commented 3 years ago

I don't understand the error. It seems to be looking for a path that does actually not exist.

12:49:35 PM:   ✖ FAIL load public/docinfo
12:49:35 PM:   | operator: load
12:49:35 PM:   | expected: 200 public/docinfo
12:49:35 PM:   |   actual: ENOENT: no such file or directory, open '/opt/build/repo/netlify/public/docinfo'
12:49:35 PM:   |       at: public/gradle-plugin/latest/docinfo/index.html:322:17 <a href="https://docs.asciidoctor.org/docinfo">...</a>
12:49:35 PM:   2519 tests
12:49:35 PM:      2 skipped
12:49:35 PM:   2518 passed
12:49:35 PM:      1 failed
12:49:35 PM:

abelsromero commented 3 years ago

Found an invalid referente, fixing :+1:

mojavelinux commented 2 years ago

Are we ready to proceed with this PR, or is it still in draft?

abelsromero commented 2 years ago

I'd need to review the status sorry, I recall the branch structure was not the same as for asciidoctorj/maven and I found some problem.

mojavelinux commented 2 years ago

No worries. I just wanted to make sure you weren't waiting on me. I'll be ready when you are ;)

abelsromero commented 1 year ago

I need to re-think this.

abelsromero commented 7 months ago

Running to get preview, when all is fine I'll open PR pointing to the branch in the official gradle repo, not my fork. @mojavelinux this is running fine locally without errors but you always spot some extra fixes. Is there anything else I should be checking other than the netifly preview.

mojavelinux commented 7 months ago

If it builds clean and the docs show up, I think that's sufficient, at least to start. We can always make adjustments after it goes live.

abelsromero commented 7 months ago

Thanks! Found an issue with a branch name thanks to the validations. This is the preview :point_right: https://deploy-preview-66--asciidoctor-docs.netlify.app/ I think it's not perfect but serviceable.

Ready to merge.

mojavelinux commented 7 months ago

This is a great start! Tremendous work. I'm so glad to see these docs finally come home.

I'd like to request a few small changes before we merging.

Change "Asciidoctorj PDF plugin" title to "AsciidoctorJ PDF plugin" (note the uppercase J)
Move "Working with Asciidoctor.js instead" to Appendices (this is very much a niche case and seems to belong there for now)
Group plugins under a "Plugins" nav entry (doesn't have to be a page)
I don't think the "Introduction" nav entry is needed as this just duplicates the start page, so it just makes it seem like the navigation is not working correctly

Does that sound reasonable?

abelsromero commented 7 months ago

Does that sound reasonable?

Sure thing! When migrating I am so focused on the technical details (attributes, includes, refs, etc.) that I lose sight of keeping cohesion and user experience.

PR ready: https://github.com/asciidoctor/asciidoctor-gradle-plugin/pull/723. Any last thing?

mojavelinux commented 7 months ago

Should we put asciidoctoreditorconfig-plugin.adoc under plugins too?

Aside from that, I think we can call it done for the first go live.

abelsromero commented 7 months ago

Moving editorconfig makes a lot of sense. Changes applied and merged, let's release then :rocket:

mojavelinux commented 7 months ago

Looks great! Super work!

Let's go! :rocket: