docs: revise developer guide documentation BM-1081 #3368
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Adds a call-out to the How to run
basemaps
locally page describing how to build Basemaps in watch mode. [commit]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]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]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
Removes unused internal links from various documentation pages. [commit]
Updates code example commands to reference
build
directories instead ofbin
directories. [commit]Corrects the description and usage of the
--output
parameter when running the basemaps/cli package. [commit]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.
Switch to this branch (
docs/dev-guide-revison
).Run the following command from the root of the repository: