Skip to content
This repository has been archived by the owner on Jul 10, 2023. It is now read-only.

Move style-spec docs to dedicated repo #400

Closed
birkskyum opened this issue Feb 16, 2023 · 3 comments · Fixed by maplibre/maplibre-style-spec#88
Closed

Move style-spec docs to dedicated repo #400

birkskyum opened this issue Feb 16, 2023 · 3 comments · Fixed by maplibre/maplibre-style-spec#88
Assignees
Labels
💰 bounty M Medium Bounty, USD 250 💰 bounty XL Extra Large Bounty, USD 1,000

Comments

@birkskyum
Copy link
Member

birkskyum commented Feb 16, 2023

Similar to the task related to the style-spec subfolder in maplibre gl js (maplibre/maplibre-gl-js#2149), the style-spec docs should also be split from the MapLibre GL JS docs. This is because the style-spec will have a different release cycle from maplibre-gl-js, and because the docs for these two packages are generated very differently:

  • MapLibre GL JS is generated by parsing JSDoc comments
  • Style Spec is a JSON document, so the docs are made in a very custom fashion.

Completion criteria:

  • Make a clone of maplibre-gl-js-docs where everything but the style-spec code is removed.
  • Use the files from the style-spec repo directly rather than a submodule or an npm package. It might be necessary to expose tsc compiled .js files, since batfish isn’t ts compatible.
  • Deploy main branch with github pages to maplibre.org/maplibre-gl-style-spec
  • Setup github action on PRs to test that docs can build
  • Setup cloudflare redirect from old to new style-spec docs
@HarelM
Copy link
Contributor

HarelM commented Feb 18, 2023

Link to bounty:
maplibre/maplibre#191

@HarelM HarelM added the 💰 bounty M Medium Bounty, USD 250 label Feb 18, 2023
@birkskyum birkskyum assigned birkskyum and unassigned krishnaglodha Mar 23, 2023
@birkskyum birkskyum changed the title Create separate style-spec docs Move style-spec docs to dedicated repo Apr 16, 2023
@maplibre maplibre deleted a comment from krishnaglodha Apr 16, 2023
@maplibre maplibre deleted a comment from krishnaglodha Apr 16, 2023
@maplibre maplibre deleted a comment from krishnaglodha Apr 16, 2023
@maplibre maplibre deleted a comment from HarelM Apr 16, 2023
@maplibre maplibre deleted a comment from HarelM Apr 16, 2023
@maplibre maplibre deleted a comment from krishnaglodha Apr 16, 2023
@maplibre maplibre deleted a comment from HarelM Apr 16, 2023
@maplibre maplibre deleted a comment from HarelM Apr 16, 2023
@birkskyum
Copy link
Member Author

birkskyum commented Apr 21, 2023

@wipfli
Copy link
Member

wipfli commented Apr 21, 2023

@birkskyum delivered the work of the original scope in pull request #23. However, in the review of this pull request, the maintainer expanded the scope of work which resulted in pull request #88. Since the new scope was larger and included rewriting a new docs generation website, we added retroactively a bounty size XL to this ticket. This shall be a one-time exception and we require maintainers to not increase the scope of a bounty and developers to clarify design decisions before starting working on implementations.

@wipfli wipfli added the 💰 bounty XL Extra Large Bounty, USD 1,000 label Apr 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💰 bounty M Medium Bounty, USD 250 💰 bounty XL Extra Large Bounty, USD 1,000
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants