PrismarineJS / PrismarineJS/minecraft-data

Create hook to auto-update the documentation on commit

Open
#194 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

automatization
Dominant language
JavaScript
Stars
938
Forks
294
Avg merge
2d 10h
Merged PRs (30d)
23

Description

http://prismarinejs.github.io/minecraft-data/ is seriously outdated. It'd be nice if we could have CircleCI automatically rebuild and push the gh-pages branch whenever we push on master.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the repository's CircleCI configuration and the existing process that builds the documentation for the gh-pages branch. Verify how pushes to master are handled and define done as an automatic rebuild and push to gh-pages after each such push.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.