Project management structure, main advices

[Jean-Baptiste-Lasselle]

• First, you need to create 2 repos :
  • https://github.com/civicpower/team-portal : this repo will remain private, and will version a https://gohugo.io project, which publishes a github pages set as private : only members of the https://github.com/civicpower Github Org will have access to that website. Core Team documentation, not for public
  • https://github.com/civicpower/civicpower.github.io : this repo will remain private, and will version a https://gohugo.io project, which publishes a github pages set as public this wil be the open soruce projhect docuementation site, where you will have all "guides" like :
  • "Deployment Guide"
  • "Contributors Guide"
  • etc...
• Other advice, since you have multiple repos :
  • create one repo, called "issues" https://github.com/civicpower/issues
  • create at https://github.com/civicpower/ Github Org level, three labels :
  • One named component_api
  • One named component_bo
  • One named component_app
  • configure github org repos to forbid anyone to open an issue on any repo, except the https://github.com/civicpower/issues repo
  • On every project root README.md add a paragraph "Openan issue" : in this paragraph you will explain, that to open an issue, people need to :
  • create an issue in the https://github.com/civicpower/issues repo
  • label the issue with :
    • the component_api label, if the issue is about the source code in https://github.com/civicpower/api
    • the component_app label, if the issue is about the source code in https://github.com/civicpower/app
    • the component_bo label, if the issue is about the source code in https://github.com/civicpower/bo
  • label the issue with additional labels "bug", "enhancement", or "documentation", to notify civic team if this is about a bug, a request for enhancement, or a documentation related issue

In the https://github.com/civicpower/civicpower.github.io repo, there must be a fully documented procedure, allowing people to provision the full software privately, at least with a docker-compose.

In the root README.md of every repo, there must be a paragraph named "How to run" , structured like this :

## How to run

### Developer setup

first explain at least the build process for this compoent, if you cannot run this component standalone

Then explain how to 

### Production setup

Here a link to the "Deployement guide" in the public github Pages versioned and deployed by the https://github.com/civicpower/civicpower.github.io repo

Here is a quick resource to setup a public github pages for free, using the hugo technology :

• follow this tutorial : https://ruddra.com/hugo-deploy-static-page-using-github-actions/
• don't use the anankehugo hugo theme, but instead use one of the many existing hugo themes , designed for documentation websites : https://themes.gohugo.io/tags/documentation/ (I advise you https://themes.gohugo.io/hugo-theme-learn/ )
• Be sure you won't loose your time learning how to use a hugo theme (not how to create your own theme) : Kubernetes project uses Hugo to create and manage its documentation
• if you need a bit of help on hugo websites, I may help later, you stil need to create the empty github repos

Social

Create right now a https://gitter.im/ or discord account for the civicpower github org :

• it's like slack,
• you wall give a "ask us a question" link on every README.md in alll repos, for developers to have a quick link to somewhere they can chatops talk to the civicpower team

Later you will create twitter account, les urgent : making it possible for people to talk to your team is more urgent than being able to tweet around and show off

[civicpower]

Hi JB, thanks for your remarks. For sure in the following weeks we might invest more time to elaborate the working group & process on those projects. It will might be really cool if you can help us when we will be ready for those modifications!