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

Add Gradle Plugin docs #66

Merged
merged 1 commit into from
Mar 12, 2024

Conversation

abelsromero
Copy link
Member

@abelsromero abelsromero commented May 2, 2021

This is for preview from the forked branch linked to PR asciidoctor/asciidoctor-gradle-plugin#601

Updated to new PR asciidoctor/asciidoctor-gradle-plugin#722

@abelsromero
Copy link
Member Author

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 abelsromero force-pushed the add-gradle-plugin-docs branch 2 times, most recently from 2bfdc7e to a7912a1 Compare May 2, 2021 12:52
@abelsromero
Copy link
Member Author

Found an invalid referente, fixing 👍

@abelsromero abelsromero force-pushed the add-gradle-plugin-docs branch 2 times, most recently from cc30c17 to f92771f Compare May 2, 2021 13:44
@mojavelinux
Copy link
Member

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

@abelsromero
Copy link
Member Author

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
Copy link
Member

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

@abelsromero abelsromero marked this pull request as draft June 18, 2023 17:33
@abelsromero
Copy link
Member Author

I need to re-think this.

@abelsromero
Copy link
Member Author

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
Copy link
Member

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 abelsromero force-pushed the add-gradle-plugin-docs branch 2 times, most recently from 643b6de to 64aeb27 Compare March 10, 2024 21:52
@abelsromero
Copy link
Member Author

abelsromero commented Mar 10, 2024

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

Ready to merge.

@abelsromero abelsromero marked this pull request as ready for review March 10, 2024 21:58
@mojavelinux
Copy link
Member

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 added a commit to abelsromero/asciidoctor-gradle-plugin that referenced this pull request Mar 11, 2024
@abelsromero
Copy link
Member Author

abelsromero commented Mar 11, 2024

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: asciidoctor/asciidoctor-gradle-plugin#723. Any last thing?

@mojavelinux
Copy link
Member

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 added a commit to abelsromero/asciidoctor-gradle-plugin that referenced this pull request Mar 12, 2024
abelsromero added a commit to abelsromero/asciidoctor-gradle-plugin that referenced this pull request Mar 12, 2024
abelsromero added a commit to asciidoctor/asciidoctor-gradle-plugin that referenced this pull request Mar 12, 2024
@abelsromero
Copy link
Member Author

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

@mojavelinux
Copy link
Member

Looks great! Super work!

Let's go! 🚀

@mojavelinux mojavelinux merged commit dba3a0c into asciidoctor:main Mar 12, 2024
4 checks passed
tylerbertrand pushed a commit to tylerbertrand/asciidoctor-gradle-plugin that referenced this pull request Apr 12, 2024
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

Successfully merging this pull request may close these issues.

2 participants