search

canonical / open-documentation-academy

Learn open-source software documentation skills with Canonical
https://canonical.com/documentation
Apache License 2.0
48 stars 30 forks source link

Snapcraft: Update Java example to use core22 #45

Closed adityasamant25 closed 2 months ago

adityasamant25 commented 3 months ago

Fixes #5

This PR updates the Snapcraft Java applications page to be compatible with the core22 base.

The existing example was based on the gradle plugin which is not supported yet for the core22 base. This PR uses a project based on maven as an example, as the maven plugin is supported in core22. The example project used is: Cal - The Console Calendar Generator

The modified commands have been tested successfully before issuing the PR.

Comments and feedback are welcome. I am available for any modifications to be made.

Kind regards, Aditya

adityasamant25 commented 2 months ago

@degville Thank you for the review. I have incorporated your suggestions and submitted a new commit.

What would be the next step in order to get these changes published?

degville commented 2 months ago

@adityasamant25 Brilliant, thank you! I think we can now merge your PR into the repository (you can do this if you wish). We can then copy the file across to the forum (I'm happy to do this, or you're most welcome to yourself too) - whatever works best for you.

adityasamant25 commented 2 months ago

@degville - Thank you!

To merge the PR into canonical/open-documentation-academy:main, I will need write access to this repository. Do I need to raise a request for that? Additionally, I doubt that I have access to the forum to copy the file across.

As it is my first contribution to the open documentation academy, I would need some help in getting through these steps.

degville commented 2 months ago

Hello @adityasamant25

I will need write access to this repository. Do I need to raise a request for that?

Sorry, this was my fault. The membership permissions for this repository are set to only allow the admins and moderators to merge, which is probably best for now. This means I'll need to merge the PR. But as with other projects, I think it will be worth looking into adding community people as moderators for the repository as the project matures - that way, they can gain the experience and we can share the burden of reviews (this is what usually happens with a project).

Additionally, I doubt that I have access to the forum to copy the file across.

This is one of the problems with Discourse - you typically need to interact with the system to gain trust levels. If you create an account on https://forum.snapcraft.io/ and share your account name with me, I'll elevate your trust level so you can make whatever changes you want. I can help you with that too, if you'd like. Let me know after you've shared your account name (I'm equally happy to do this myself, if you'd prefer).

degville commented 2 months ago

Big thank you to @adityasamant25 for all the work on this. I'm going to merge this PR. We can mark this task as closed when we've copied the text back to the forum.

adityasamant25 commented 2 months ago

@degville I've just created a new account at https://forum.snapcraft.io. My account name is adityasamant

degville commented 2 months ago

adityasamant

Brilliant, thank you! I've upped your trust level. You should now be able to see the Edit button at the bottom of the Java applications forum post and paste your updates into this. A lot of this is covered here: https://snapcraft.io/docs/contribute-to-docs

Let me know if I can help.

adityasamant25 commented 2 months ago

@degville, its done. The Java applications forum post has been updated with the changes. :)

degville commented 2 months ago

Brilliant, thank you so much! Looks fab!