This repository is a collection of git subtrees for LFE reference materials
published at lfe.io/reference/lfe-rebar3/.
Acutal reference content is mainted in Markdown files in builder branches (see the repositories linked below). Content is generated in master branches. Pull requests need to be issued against the Markdown files in the builder branches below.
Any feedback, bugs, requests, etc., should be filed against the appropriate software reference in the links below.
Developers and contributers should scroll to the bottom of this file to read instructions on how to incorporate and publish changes to the LFE books.
This includes core LFE software documentation, tooling, libraries, applications, etc.
If you are lookng for LFE books, guides, etc., you should visit https://github.com/lfe/books.
- To update a reference, visit the repository for that reference (linked above).
- For the repository, and clone to your machine.
- Create a branch for your change, commit, and push to your fork.
- Issue a PR against the reference publisher's repository for the reference.
At this point, a reviewer will examine the change, provide feedback, and iterate with you on any needed changes.
Once approved, the changes will be merged to the builder branch and the reviewer will publish these changes to master.
Then the reviewer will update the master branch that collects all publised LFE reference materials (https://github.com/lfe/reference) and push that up to Github, at which point you changes will show up for the given reference.
When adding new refererence materials to the repo, be sure to run make first: this will remind you of the steps needed (i.e., updates to the Makefile and README).
Once those changes are made, to add the actual content for new refererence material, run make init-YOUR-REFERENCE.
To publish any changes made upstream (e.g., after the merging of a pull request), be sure to run make publish in your working directoy of this project. After that, the latest version of all reference materials will be published.