Skip to content

Commit

Permalink
minor improvements to the go docs
Browse files Browse the repository at this point in the history
  • Loading branch information
javierdelapuente committed Oct 3, 2024
1 parent 5e9bcc8 commit f00280e
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/reference/extensions/go-framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ next snippet:
bin/anotherserver: usr/local/bin/<rockcraft project name>
``parts`` > ``go-framework/assets`` > ``assets``
``parts`` > ``go-framework/assets`` > ``stage``
=========================================================


Some files, if they exist, are included by default. These include:
``migrate``, ``migrate.sh``, ``templates/`` and ``static/``.

You can customise the files to include overriding the ``stage`` property
You can customise the files to include by overriding the ``stage`` property
of the ``go-framework/assets`` part:

.. code-block:: yaml
Expand Down
2 changes: 2 additions & 0 deletions docs/tutorial/code/go/task.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -105,5 +105,7 @@ execute: |
# delete all the files created during the tutorial
rm go.mod rockcraft.yaml main.go go-hello-world \
go-hello-world_0.1_amd64.rock \
cmd/anotherserver/main.go \
go-hello-world_0.2_amd64.rock
rmdir -p cmd/anotherserver
# [docs:cleanup-end]
7 changes: 4 additions & 3 deletions docs/tutorial/go.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,9 @@ extension:
on an ``amd64`` platform, the name of the ``.rock`` file will be different
for you.

The size of your rock may vary depending on factors like the architecture
you are building on and the packages installed at the time of packing.
By default, the ``go-framework` will use the ``bare`` base. You can improve
the developer experience changing the base to ``[email protected]``, but the
image size will increase.


Run the Go rock with Docker
Expand Down Expand Up @@ -224,7 +225,7 @@ You should expect to see something similar to this:
2024-10-01T06:32:58.214Z [fastapi] INFO: 172.17.0.1:55232 - "GET / HTTP/1.1" 200 OK
You can also choose to follow the logs by using the ``-f`` option with the
``pebble logs`` command above. To stop following the logs, press ``ctrl+c``.
``pebble logs`` command above. To stop following the logs, press :kbd:`Ctrl` + :kbd:`C`.


Cleanup
Expand Down

0 comments on commit f00280e

Please sign in to comment.