-
Notifications
You must be signed in to change notification settings - Fork 1
Retrospective
Based on the work done so far, the team has made the following observations and have added future tasks to improve on the current workflow :
- Looking at various OSS repositories on Github has given us a fair share of how they get organized on Github and how inviting "contributors" to the repo is a good idea.
- We observed that having a well-elaborated "Readme" file on the repository is basis of a good repository. So we have added that in the improvement plan below.
- A wiki page on Github should also be added to inform our readers about the domain we are working on. This step will take care of the non-technical readers who are curious about this domain and it's possibilities.
- Here are the improvement plans for the observations made above
Update the following sections in the Readme :
About the repo
About structured journalism - (provide internal and external resources)
How to use this Repo
Projects overview
Getting started
Link to resource groups
- We agreed on proceeding with a custom template to be deployed on github pages rather than prebuilt Jekyll themes. This was observed due to limited Jekyll themes and not all Jekyll themes could be deployed with github pages, they need a work-around for deployment. Using a custom template that fits your approach was easier.
- The deployment using the folder structure that github recognizes is fairly easy. We agreed on using the same structure so that deployment remains automatic .
- It was easier to shape our content on the design rather than the other way - designing the UX and then shaping our content. This approach seemed better and very less time consuming.
- We need to work on changing the existing design on following :
The placeholders will be replaced with content and resource groups that the founder team is working on.
Few more web components will be added to accommodate our research content.
The design will be changed to fit everything on one page, thus proceeding towards a single-page website.
In this build phase, the team had a better understanding of how to approach the code and structure this repository. We had an exponential learning curve with flats in between and a slope again :
- The idea of animation video was good and innovative. The meeting with design team proved that architecture animation and voice over was actually good for idea delivery.
- The about us page was more personalized and came out good. it is often related to the fact that project is not done and over and there is a community of developers actively and dedicatedly working on it.
- The design changes w.r.t. color palette and DXC-BBC theme came out good.
- Minimalistic Card design did a good job of providing enough information without being cumbersome.
- CTA were placed well.
- Majority of the work was done as planned however maintaining the page responsiveness was overlooked considering that it will not be affected. Although the work around did not take more than a day's effort, it is a good point to consider "code for responsiveness".
- The animation video editing and upload could make page a little heavy to load , so it is not known yet.
- Pre-resize images could be a good option to make page less heavy. We will look into that.
- Code cleanup is often overlooked but necessary.
- Proof reading the pages again for some grammatical issues was overlooked . This is in-line as well.
- Repository management:
Successfully adding external feature/repo as a module within our repo. Adding Wiki pages to provide more information. Structuring repository
Adding Installations steps for Article production & journalism automation project in developers community ReadME. Inputs from BBC/ design team will be incorporated and worked upon.