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

Go tutorial and reference #723

Merged
merged 67 commits into from
Nov 27, 2024
Merged

Conversation

javierdelapuente
Copy link
Contributor

@javierdelapuente javierdelapuente commented Oct 2, 2024

  • Have you signed the CLA?

Adds a tutorial and reference docs for the Go extension

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 2, 2024
@javierdelapuente javierdelapuente marked this pull request as ready for review October 3, 2024 14:34
docs/tutorial/go.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@jdkandersson jdkandersson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looked at the tutorial, I think it is a good start

docs/tutorial/code/go/main.go Outdated Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/code/go/main.go.time Show resolved Hide resolved
docs/tutorial/code/go/main.go Outdated Show resolved Hide resolved
docs/tutorial/code/go/main.go.time Outdated Show resolved Hide resolved
docs/tutorial/code/go/main.go.time Outdated Show resolved Hide resolved
docs/tutorial/code/go/task.yaml Outdated Show resolved Hide resolved
Copy link

@IronCore864 IronCore864 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a relatively new user, I tried to follow the tutorial but failed (there isn't a go-framework profile). But I still read through the tutorial thoroughly. There are some nitpicking comments, but mostly are my thoughts on naming consistency and content organisation. See comments inline.

docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Show resolved Hide resolved
@javierdelapuente
Copy link
Contributor Author

javierdelapuente commented Oct 10, 2024

As a relatively new user, I tried to follow the tutorial but failed (there isn't a go-framework profile). But I still read through the tutorial thoroughly. There are some nitpicking comments, but mostly are my thoughts on naming consistency and content organisation. See comments inline.

Thank you very much for your review!. With respect to not being able to run it, it should be related to the need to refresh to the latest/edge channel (using for example sudo snap refresh rockcraft --channel latest/edge). The go-framework is not yet in rockcraft stable (it will be when the tutorial is in the stable readthedocs page).

docs/tutorial/go.rst Outdated Show resolved Hide resolved
docs/tutorial/go.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@medubelko medubelko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for getting back so soon, @javierdelapuente! I have some requests for small language changes in the newer text. Nothing major. I think the rest is fine to publish. Do you have plans to address/close the remaining suggestions from everyone else?

docs/tutorial/go.rst Outdated Show resolved Hide resolved
@medubelko
Copy link
Contributor

Odd, GitHub split my suggestions into separate reviews. Not sure why.

@javierdelapuente
Copy link
Contributor Author

Thanks for getting back so soon, @javierdelapuente! I have some requests for small language changes in the newer text. Nothing major. I think the rest is fine to publish. Do you have plans to address/close the remaining suggestions from everyone else?

I have closed all conversations, as all of them were already addresses/replied.

@medubelko
Copy link
Contributor

@tigarmo Shall we merge?

@tigarmo tigarmo merged commit 521c3f7 into canonical:main Nov 27, 2024
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants