Learning documentation day 2 - sandyMax974/acebook-markzuckerbergisalizard GitHub Wiki

Day 2

After taking the first afternoon of day 1 away to do some reading and research, we grouped back up on day 2 to consolidate our findings and attempt to fill in any knowledge gap between us before carrying on. Most of the research was spent around understanding the Rails set up directories, knowing where are all the necessary files and folders are , as well as their use. Second was looking into the importance, usefulness and set up of Heroku.

The first task of the day was to start assigning roles, and to evaluate priority on user stories. We went ahead and assigned Scrum Master and Scribe/Reporter roles to two team member (CC & NB respectively).

Tasks for the day

The first step the group took was to set up the homepage and deploy it on Heroku. We also had a look at decomposing the "User can Sign Up" User story into smaller ones:

  • create user model
  • account authentication
  • password encryption
  • edge cases

After group reflection we decided the priority should be:

  • Test coverage, quality checks, code style (KW & SP)
  • Ordering posts by newest (CC & MC)
  • Starting on the User sign up (JH & NB)

In terms of documentation, we looked at:

Obstacles

  • It seems the branch needs to be "main" rather than "master" in Heroku. We had to change this to be able to deploy Rails into Heroku.
  • Rails uses a slightly different syntax to ruby, there would be quite a lot of refactoring to go through to clean the code.
  • To look into CI/CD, a full access to the repo is necessary. This had to be left aside until the team could meet up during the retro and change access permissions to the repo.

Concrete learning

  • Rails uses a lot of inbuilt method and frameworks, which facilitates coding and creation of different tables, classes etc. but also needs getting used to a new syntax.
  • Learnt how to add a test coverage that prompts when running the server. It gives a detailed summary of all Rails files.
  • Changed the posts textbox to accept line return/ line breaks

To address tomorrow

  • Sign up / Sign in / Sign Out
  • Finishing the test coverage (some bits missing
  • CI/CD
  • Sprint Review