Code Releases

Frontity keeps the docs updated with the latest features released in the source code.

This is the community discussion regarding this topic: Code <-> Documentation workflow

For every new feature, bug fixing or code update that requires a change in the docs, this is the workflow to follow on both the code repository (code PR) and the docs repostitory (docs PR):

• When the code PR is opened, one member of DevRel team (the one who is the supporter for the week) should be assigned to the PR (as assignee, not as reviewer)
• DevRel team will be in charge of opening the proper docs PR in the documentation repository (and all extra tasks or actions required)
• The developer in charge of the code PR will be added as reviewer of the docs PR
• The approval of the developer in charge of the code PR will be required to merge the docs PR
• Once the docs PR is created, DevRel team will add a link to it in the code PR and mark the documentation checkbox as checked

• With this link (docs PR), DevRel can unassign themselves from the code PR

Documentation changes before code releases

• These docs PR associated with code PR cannot be merged until the release of the code is done.
• These specific docs PR should be done against a specific branch (named code) whose only purpose is to store code changes
• Once the PR has been approved the docs PR can be merged (from XXX-branch into code) when the code PR has also been merged into dev
• After every code release, code branch can be manually merged (from code into master)