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

docs: revise developer guide documentation BM-1081 #3368

Merged
merged 8 commits into from
Nov 27, 2024

Conversation

tawera-manaena
Copy link
Contributor

@tawera-manaena tawera-manaena commented Nov 6, 2024

Motivation

As a Basemaps developer, when I run Basemaps locally using the developer guide, assets (glyphs and sprites) don't load when enabling the labels feature or viewing the Topographic layer.

  • This pull request updates the developer guide documentation to include details about the additional parameters required to serve vector tile imagery with assets.

  • This pull request also includes some minor cleanup and re-formatting of the existing developer guide documentation.

Modifications

Additions

  1. Adds a call-out to the How to run basemaps locally page describing how to build Basemaps in watch mode. [commit]

  2. Adds a new page titled "Bundle the basemaps assets archive" to the CLI methods section. The new page describes how to generate the basemaps bundled assets archive using the basemaps/cli package. [commit]

  3. Adds details to the Server methods section's Serve basemaps using a bundled config file page describing the value of the assets archive and why you may need to use it. [commit]

  4. Adds details to the new "Bundle the basemaps assets archive" page describing how to generate the asset files (glyph files and sprite sheets) required to bundle the assets archive. [commit]

Revisions

  1. Removes unused internal links from various documentation pages. [commit]

  2. Updates code example commands to reference build directories instead of bin directories. [commit]

  3. Corrects the description and usage of the --output parameter when running the basemaps/cli package. [commit]

  4. Fixes minor spelling errors and formatting inconsistencies for various documentation pages. [commit]

Verification

You can view the updated developer guide documentation by following these steps.

  1. Switch to this branch (docs/dev-guide-revison).

  2. Run the following command from the root of the repository:

# serve the Basemaps docs locally
docker run --rm \
    -v $PWD:/docs \
    -p 8000:8000 \
    ghcr.io/linz/basemaps-mkdocs:v1 serve -a 0.0.0.0:8000

@tawera-manaena tawera-manaena marked this pull request as ready for review November 26, 2024 22:00
@tawera-manaena tawera-manaena requested a review from a team as a code owner November 26, 2024 22:00
@tawera-manaena tawera-manaena added this pull request to the merge queue Nov 27, 2024
Merged via the queue into master with commit c3c795b Nov 27, 2024
11 checks passed
@tawera-manaena tawera-manaena deleted the docs/dev-guide-revision branch November 27, 2024 02:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants