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

Fix glob links. #43

Merged
merged 1 commit into from
Jul 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions content/guides/additional/software-distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,13 @@ In the text editor, we'll add the following:
==
```

You can refer to the [Docket File](/guides/additional/dist/docket) documentation for more details of what is required. In brief, the `desk.docket-0` file contains a `hoon` list of [clauses](/guides/additional/dist/docket) which configure the appearance of the app tile, the source of the [glob](/guides/additional/dist/glob), and some other metadata.
You can refer to the [Docket File](/reference/additional/dist/docket) documentation for more details of what is required. In brief, the `desk.docket-0` file contains a `hoon` list of [clauses](/reference/additional/dist/docket) which configure the appearance of the app tile, the source of the [glob](/reference/additional/dist/glob), and some other metadata.

We've given the app a [`%title`](/guides/additional/dist/docket#title) of "Hello", which will be displayed on the app tile and will be the name of the app when others browse to install it. We've given the app tile a [`%color`](/guides/additional/dist/docket#color) of `#8188C9`, and also specified the URL of an [`%image`](/guides/additional/dist/docket#image) to display on the tile.
We've given the app a [`%title`](/reference/additional/dist/docket#title) of "Hello", which will be displayed on the app tile and will be the name of the app when others browse to install it. We've given the app tile a [`%color`](/reference/additional/dist/docket#color) of `#8188C9`, and also specified the URL of an [`%image`](/reference/additional/dist/docket#image) to display on the tile.

The [`%base`](/guides/additional/dist/docket#base) clause specifies the base URL path for the app. We've specified "hello" so it'll be `http://localhost:8080/apps/hello/...` in the browser. For the [glob](/guides/additional/dist/glob), we've used a clause of [`%glob-ames`](/guides/additional/dist/docket#glob-ames), which means the glob will be served from a ship over Ames, as opposed to being served over HTTP with a [`%glob-http`](/guides/additional/dist/docket#glob-http) clause or having an Eyre binding with a [`%site`](/guides/additional/dist/docket#site) clause. You can refer to the [glob](/guides/additional/dist/glob) documentation for more details of the glob options. In our case we've specified `[~zod 0v0]`. Since `~zod` is the fakeship we'll install it on, the `%docket` agent will await a separate upload of the `glob`, so we can just specify `0v0` here as it'll get overwritten later.
The [`%base`](/reference/additional/dist/docket#base) clause specifies the base URL path for the app. We've specified "hello" so it'll be `http://localhost:8080/apps/hello/...` in the browser. For the [glob](/reference/additional/dist/glob), we've used a clause of [`%glob-ames`](/reference/additional/dist/docket#glob-ames), which means the glob will be served from a ship over Ames, as opposed to being served over HTTP with a [`%glob-http`](/reference/additional/dist/docket#glob-http) clause or having an Eyre binding with a [`%site`](/reference/additional/dist/docket#site) clause. You can refer to the [glob](/reference/additional/dist/glob) documentation for more details of the glob options. In our case we've specified `[~zod 0v0]`. Since `~zod` is the fakeship we'll install it on, the `%docket` agent will await a separate upload of the `glob`, so we can just specify `0v0` here as it'll get overwritten later.

The [`%version`](/guides/additional/dist/docket#version) clause specifies the version as a triple of major version, minor version and patch version. The rest is just some additional informative metadata which will be displayed in _App Info_.
The [`%version`](/reference/additional/dist/docket#version) clause specifies the version as a triple of major version, minor version and patch version. The rest is just some additional informative metadata which will be displayed in _App Info_.

So let's save that to the `desk.docket-0` file and have a look at our desk:

Expand Down Expand Up @@ -160,7 +160,7 @@ kiln: installing %hello locally
docket: awaiting manual glob for %hello desk
```

The `docket: awaiting manual glob for %hello desk` message is because our `desk.docket-0` file includes a [`%glob-ames`](/guides/additional/dist/docket#glob-ames) clause which specifies our ship as the source, so it's waiting for us to upload the glob.
The `docket: awaiting manual glob for %hello desk` message is because our `desk.docket-0` file includes a [`%glob-ames`](/reference/additional/dist/docket#glob-ames) clause which specifies our ship as the source, so it's waiting for us to upload the glob.

If we open a browser now, navigate to `http://localhost:8080` and login with the default fakezod code `lidlut-tabwed-pillex-ridrup`, we'll see our tile's appeared but it says "installing" with a spinner due to the missing glob:

Expand Down Expand Up @@ -226,7 +226,7 @@ Our `hello-glob` folder should now look like this:

## Upload to glob

We can now create a glob from the directory. To do so, navigate to `http://localhost:8080/docket/upload` in the browser. This will bring up the `%docket` app's [Globulator](/guides/additional/dist/glob#globulator) tool:
We can now create a glob from the directory. To do so, navigate to `http://localhost:8080/docket/upload` in the browser. This will bring up the `%docket` app's [Globulator](/reference/additional/dist/glob#globulator) tool:

![Globulator](https://media.urbit.org/guides/additional/dist/globulator.png)

Expand Down
6 changes: 3 additions & 3 deletions content/guides/core/app-school-full-stack/8-desk.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ The fields are as follows:
hash of those files automatically. Note that it's also possible to distribute
front-end files from a separate web server. In that case, you'd use
`glob-http` rather than `glob-ames`. The [Glob section of the distribution
guide](/guides/additional/dist/glob) covers this alternative approach in more
guide](/reference/additional/dist/glob) covers this alternative approach in more
detail.

Our files should now look like this:
Expand Down Expand Up @@ -214,11 +214,11 @@ from our ship. To do that, we just run the following command in the dojo:

## Resources

- [App publishing/distribution documentation](/guides/additional/dist/dist) -
- [App publishing/distribution documentation](/reference/additional/dist/dist) -
Documentation covering third party desk composition, publishing and
distribution.

- [Glob documentation](/guides/additional/dist/glob) - Comprehensive documentation
- [Glob documentation](/reference/additional/dist/glob) - Comprehensive documentation
of handling front-end files.

- [Desk publishing guide](/guides/additional/dist/guide) - A step-by-step guide to
Expand Down
6 changes: 3 additions & 3 deletions content/guides/core/app-school-full-stack/9-final.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,12 @@ Here is the reference material for each section of this walkthrough.

#### Desk and Glob

- [App publishing/distribution docs](/guides/additional/dist/dist) -
- [App publishing/distribution docs](/guides/additional/software-distribution) -
Documentation covering third party desk composition, publishing and
distribution.

- [Glob documentation](/guides/additional/dist/glob) - Comprehensive documentation
- [Glob documentation](/reference/additional/dist/glob) - Comprehensive documentation
of handling front-end files.

- [Desk publishing guide](/guides/additional/dist/guide) - A step-by-step guide to
- [Desk publishing guide](/guides/additional/software-distribution) - A step-by-step guide to
creating and publishing a desk.
2 changes: 1 addition & 1 deletion content/reference/arvo/reference/filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ desks and their Gall agents:
automatically started when it's installed. This file may be omitted if there
are no agents to start.
- `desk.docket-0` - This file configures the tile,
[glob](/guides/additional/dist/glob) and other metadata for apps with a
[glob](/reference/additional/dist/glob) and other metadata for apps with a
front-end. This file may be omitted if the desk does not have a tile or
front-end to be installed. This file is versioned so the number appended may
change in the future as changes to its specification are made. See the [Docket
Expand Down