SJRK-321: Migrate code from stories-floe-dev to master branch

Metadata

Source
SJRK-321
Type
Task
Priority
Major
Status
Closed
Resolution
Fixed
Assignee
N/A
Reporter
Gregor Moss
Created
2020-01-16T16:31:44.213-0500
Updated
2020-04-03T12:43:47.560-0400
Versions
N/A
Fixed Versions
N/A
Component
  1. Storytelling Tool Server
  2. Storytelling Tool UI

Description

The branch stories-floe-dev is currently being treated as a sort of master branch while the codebase is slowly inching towards satisfying fluid-project standards for inclusion in the master branch.

At least one metric of success is fully passing the Laser Eye Checklist.

Meanwhile, there are other fluid-project sites running out of their master branches, and we have been exploring the notion of a flexible code standard in FLUID-6358. With this in mind, we should aim to stop using stories-floe-dev in this manner and promote its contents to the master branch.

This should also include an update to the README or a new documentation file (in the "docs" directory) which details all of the branches in the main fork of this repository and what they are each used for.

The stories-floe-dev branch is currently the basis for the CI build of the FLOE Storytelling Tool staging site, so this should also be considered. Should master be the new basis for the staging site or would it be appropriate to leave it as it is?

Comments

  • Gregor Moss commented 2020-01-28T14:46:18.356-0500

    The code has been merged into the master branch as a result of the work on SJRK-255.

    Still remaining:

    • ensure the Laser Eye Checklist is satisfied
    • update the documentation (recommend adding a new file) detailing the branches used for site deployment
    • consider what to do about the staging site deployment
  • Gregor Moss commented 2020-02-21T17:02:40.978-0500

    In creating my BRANCHES.md file, I've noticed that the two branches learning-to-learn and re-review are not used. As such I recommend that we delete them along with stories-floe-dev when the time comes.

    For a bit of context, learning-to-learn was once our main development base (much as stories-floe-dev was after that and master is now) and re-review is a branch that @@Antranig Basman set up for his holistic review efforts that culminated in the SJRK-255 work being merged in and the project being updated to satisfy FLUID-6145 and FLUID-6148.

  • Gregor Moss commented 2020-02-21T17:12:03.709-0500

    I have also noticed in my review of the CI jobs that the Karisma site (https://karisma-stories.floeproject.org/) is being deployed from a particular branch in @@Alan Harnum's fork of the code: https://github.com/waharnum/sjrk-story-telling-server/tree/SJRK-56-karisma. Transitioning off of that and onto a more "mainline" branch of the code may involve a bit of work bringing that particular theme up to date, since it was originally deployed nearly two years ago, so perhaps that effort deserves its own Jira.

  • Cindy Li commented 2020-03-17T13:16:56.552-0400

    The pull request that completes the documentation has been merged into to the project repo master branch at this commit.