Create a websites / web publishing process document #280

Closed
opened 2024-09-25 11:15:41 +00:00 by gosam · 18 comments
Owner

It was requested to make a website / web publishing process document

  • Who owns what?
  • Who to go to with which questions?
  • What is the process to push websites live?
  • Who needs to review?
  • List of repos
  • Etc
It was requested to make a website / web publishing process document - Who owns what? - Who to go to with which questions? - What is the process to push websites live? - Who needs to review? - List of repos - Etc
sashaastiadi was assigned by gosam 2024-09-25 11:15:41 +00:00
gosam added this to the Sep 16 – Sep 29 project 2024-09-25 11:15:41 +00:00
Author
Owner

@sashaastiadi Can you lead this? I can help.

@sashaastiadi Can you lead this? I can help.
Owner

sure will do now
maybe for all request ill make a issue templates

sure will do now maybe for all request ill make a issue templates
gosam modified the project from Sep 16 – Sep 29 to Sep 30 – Oct 13 2024-09-27 06:35:26 +00:00
Author
Owner

@sashaastiadi please update and as proposed in the chat maybe it's better for you to create your own issue on your own board.

@sashaastiadi please update and as proposed in the chat maybe it's better for you to create your own issue on your own board.
gosam removed this from the Sep 30 – Oct 13 project 2024-10-14 07:41:10 +00:00
Owner

ongoing and related discussion on

--

we have repo for web presence:

our challenges:

  • we're in the process of moving github web repos to gitea

  • each web repos in gitea exist in its respective parent company org (e.g ourverse website is under ourworld gitea organization)

  • issues created in different repos under different organizations cant all be tracked automatically within 1 project board

  • sasha (1 person) both manages the board and also fix the problems herself (issues related to web presence alone) normally, occasionally with the help of ehab+samar (they first prioritize the UI / front end of tgrid related apps/projects)

  • we have a lot of webites, it simply is a challenge to check each repo on gitea and github for issues

  • stakeholders (kds, flo, whoever) most of the time randomly ask to create new website without clear project brief document

  • stakeholders ping on telegram to fix issues instead of creating issues themselves to https://git.ourworld.tf/tfgrid/circle_web_presence/issues - many, issues remain undocumented or i myself at the end create an issue on behalf of stakeholders + fix them myself . (people dont follow process even if process exist)

solution

so the easiest solution for now, for new website requests and updates:
stakeholders / users need go to https://git.ourworld.tf/tfgrid/circle_web_presence/issues and make an issue so i can just check 1 board, and all issues accross web repos unify there.

todo

  • review/discuss for a better solution , but i do believe to track each issue within one repo is preferrable.

  • make a howto doc

  • need to go together with @mik-tf to include a howto doc on manual

  • put same doc on readme.md of each repo

ongoing and related discussion on - [ ] https://git.ourworld.tf/tfgrid/circle_web_presence/issues/29 - [ ] https://git.ourworld.tf/tfgrid/circle_promotion/issues/278 -- we have repo for web presence: - https://git.ourworld.tf/tfgrid/circle_web_presence - need to update https://git.ourworld.tf/tfgrid/circle_web_presence/src/branch/main/README.md but basic info is there - we have an updated web sheet on: https://docs.google.com/spreadsheets/d/1RsCcmXt2ds4wWK-Tdp6KokyoGl-dEW96W84O89eiE4U/edit?gid=1278046035#gid=1278046035 - we have https://git.ourworld.tf/tfgrid/circle_web_presence/issues - unify all web-related issues. previously we used to create issues in each respective repos, - readme usually self-explanatory - e.g https://git.ourworld.tf/tfcoop/www_tf9_new ## our challenges: - we're in the process of moving github web repos to gitea - each web repos in gitea exist in its respective parent company org (e.g ourverse website is under ourworld gitea organization) - issues created in different repos under different organizations cant all be tracked automatically within 1 project board - sasha (1 person) both manages the board and also fix the problems herself (issues related to web presence alone) normally, occasionally with the help of ehab+samar (they first prioritize the UI / front end of tgrid related apps/projects) - we have a lot of webites, it simply is a challenge to check each repo on gitea and github for issues - stakeholders (kds, flo, whoever) most of the time randomly ask to create new website without clear project brief document - stakeholders ping on telegram to fix issues instead of creating issues themselves to https://git.ourworld.tf/tfgrid/circle_web_presence/issues - many, issues remain undocumented or i myself at the end create an issue on behalf of stakeholders + fix them myself . (people dont follow process even if process exist) ## solution so the easiest solution for now, for new website requests and updates: stakeholders / users need go to https://git.ourworld.tf/tfgrid/circle_web_presence/issues and make an issue so i can just check 1 board, and all issues accross web repos unify there. ## todo - [x] review/discuss for a better solution , but i do believe to track each issue within one repo is preferrable. - [ ] make a howto doc - [ ] need to go together with @mik-tf to include a howto doc on manual - [ ] put same doc on readme.md of each repo
Owner

@sashaastiadi

I think there is an easy fix for this: issues created in different repos under different organizations cant all be tracked automatically within 1 project board

We can set each repo to link to an external issue tracker which would be the web presence kanban. Already started to be organized like this with info_tfgrid. Test: go to https://git.ourworld.tf/tfgrid/info_tfgrid and click on issues. Lmk if you like this process

In Settings we simply have to do this:

image

@sashaastiadi I think there is an easy fix for this: issues created in different repos under different organizations cant all be tracked automatically within 1 project board We can set each repo to link to an external issue tracker which would be the web presence kanban. Already started to be organized like this with info_tfgrid. Test: go to https://git.ourworld.tf/tfgrid/info_tfgrid and click on issues. Lmk if you like this process In Settings we simply have to do this: ![image](/attachments/c6201a25-564b-4b53-b10c-e419c4e1de9e)
Owner

Update

Public Websites Issue Tracker Set to Web presence kanban (see here: https://git.ourworld.tf/tfgrid/circle_web_presence/projects/35)

Notes

I am making the setup work for all public repos. We could discuss if we should do a private/internal website tracker for private/internal repos, e.g. https://git.ourworld.tf/mbweni_gardens

Internal/Private Websites/Repos

# Update ## Public Websites Issue Tracker Set to Web presence kanban (see here: https://git.ourworld.tf/tfgrid/circle_web_presence/projects/35) - info_tfgrid - https://git.ourworld.tf/tfgrid/info_tfgrid - tf9 - https://git.ourworld.tf/tfcoop/www_tf9_new - ourworld_web/ourverse_new - https://git.ourworld.tf/ourworld_web/ourverse_new - TF Docs - https://git.ourworld.tf/tfgrid/docs_tfgrid4 ## Notes I am making the setup work for all public repos. We could discuss if we should do a private/internal website tracker for private/internal repos, e.g. https://git.ourworld.tf/mbweni_gardens ## Internal/Private Websites/Repos - TF Internal Docs - https://git.ourworld.tf/tfgrid/info_tf_internal - Mbweni_Gardens - https://git.ourworld.tf/mbweni_gardens
Owner

UX Workflow

  • Someone sees an error on a repo
  • They go on the repo, and click on Issues
    image
  • This leads them to the Kanban website presence
    image
  • On the project description, we explain how to create the issue
    image
# UX Workflow - Someone sees an error on a repo - They go on the repo, and click on Issues ![image](/attachments/b5858b6e-457d-468b-9e92-e8f1ce45501b) - This leads them to the Kanban website presence ![image](/attachments/17408276-bf31-4987-ac42-78407ebc4869) - On the project description, we explain how to create the issue ![image](/attachments/f9bfd776-cfc5-42ba-860a-27c98cdfaa35)
Owner

perfect, example works thanks @mik-tf ! i will go through each repo now and make sure they all linked to web_presence.

perfect, example works thanks @mik-tf ! i will go through each repo now and make sure they all linked to web_presence.
Owner

Update

# Update - We use this: https://git.ourworld.tf/tfgrid/circle_web_presence/issues/new?project=35 - instead of this: https://git.ourworld.tf/tfgrid/circle_web_presence/projects/35 - This makes it easier for people to create issue - Make sure the kanban web presence has a clear issue template with info on how to write the issue - Status: Done on main branch, see - default: https://git.ourworld.tf/tfgrid/circle_web_presence/issues/new - all templates: https://git.ourworld.tf/tfgrid/circle_web_presence/issues/new/choose
mik-tf was assigned by gosam 2024-10-14 15:40:52 +00:00
gosam added this to the Oct 14 – Oct 27 project 2024-10-14 15:42:16 +00:00
Owner

Issue Process

  • All websites link to the website presence kanban default issue template: https://git.ourworld.tf/tfgrid/circle_web_presence/issues/new?project=35
    • When there are issues, people click on the button Issues on the respective repo, then it leads to the default issue template
  • Website presence circle can track the issues of all website in one place and assign issues so they get completed

Notes

Docs

Specs

@gosam answers below. All the "answers" and proper info will be in Sasha's spreadsheet. As I understand we don't need any more documentation for now. Once this spreadsheet is completed, we can close this issue as I understand.

# Issue Process - All websites link to the website presence kanban default issue template: https://git.ourworld.tf/tfgrid/circle_web_presence/issues/new?project=35 - When there are issues, people click on the button Issues on the respective repo, then it leads to the default issue template - Website presence circle can track the issues of all website in one place and assign issues so they get completed # Notes - To add link to website tracker for each repo, go to Settings -> Advanced Settings --> Use External Tracker --> set https://git.ourworld.tf/tfgrid/circle_web_presence/issues/new?project=35 # Docs - We have basic Gitea docs on the manual: https://manual.grid.tf/documentation/system_administrators/computer_it_basics/gitea/gitea_basics.html - TODO - add docs on branches protection, external issue tracker setup, issue templates - add info required in this repo where needed, see below # Specs @gosam answers below. All the "answers" and proper info will be in Sasha's spreadsheet. As I understand we don't need any more documentation for now. Once this spreadsheet is completed, we can close this issue as I understand. - Who owns what? - as defined in this spreadsheet: https://docs.google.com/spreadsheets/u/2/d/1RsCcmXt2ds4wWK-Tdp6KokyoGl-dEW96W84O89eiE4U/edit?gid=1278046035#gid=1278046035 - Who to go to with which questions? - click create issue, it goes on the proper website presence issue tracker - What is the process to push websites live? - this is the CI/CD deployment - WIP to have it automated - for now done manually on the gitea server and other methods - Who needs to review? - the owners will make sure issues and PRs are reviewed properly - List of repos - as defined in this spreadsheet: https://docs.google.com/spreadsheets/u/2/d/1RsCcmXt2ds4wWK-Tdp6KokyoGl-dEW96W84O89eiE4U/edit?gid=1278046035#gid=1278046035
Owner

perfect, example works thanks @mik-tf ! i will go through each repo now and make sure they all linked to web_presence.

Great! LMK if you need help. Once we have all the external issue tracker set to all repos, and that all websites are documented in your spreadsheet, we're good! Thanks.

URL for issue tracker: https://git.ourworld.tf/tfgrid/circle_web_presence/issues/new?project=35

> perfect, example works thanks @mik-tf ! i will go through each repo now and make sure they all linked to web_presence. > > Great! LMK if you need help. Once we have all the external issue tracker set to all repos, and that all websites are documented in your spreadsheet, we're good! Thanks. URL for issue tracker: https://git.ourworld.tf/tfgrid/circle_web_presence/issues/new?project=35
Member

Hi all, if there is an issue with the websites don't hesitate to assign me I can handle both at tfgrid and other websites

Hi all, if there is an issue with the websites don't hesitate to assign me I can handle both at tfgrid and other websites
Owner

Thanks Ehab! I confirm you always fixed issues quickly and with great care. Thanks!

Thanks Ehab! I confirm you always fixed issues quickly and with great care. Thanks!
Author
Owner

Moving to verification. Let's go through this issue today during our team call and fold it into the above issue. To me it's all related / the same.

Moving to verification. Let's go through this issue today during our team call and fold it into the above issue. To me it's all related / the same.
Owner

Done as I understand.

Done as I understand.
Owner

https://git.ourworld.tf/ourworld_web/circle_web_presence/wiki/?action=_pages

we can move these pages somewhere on internal manual?

@mik-tf

https://git.ourworld.tf/ourworld_web/circle_web_presence/wiki/?action=_pages we can move these pages somewhere on internal manual? @mik-tf
Owner

Of course. Amanda managed that book in the past. @Amanda wdyt? Can you add those pages. I can review the PR

Of course. Amanda managed that book in the past. @Amanda wdyt? Can you add those pages. I can review the PR
Owner

@mik-tf @Amanda lets move the conversation here ourworld_web/circle_web_presence#40 (comment)

@mik-tf @Amanda lets move the conversation here https://git.ourworld.tf/ourworld_web/circle_web_presence/issues/40#issuecomment-9538
Sign in to join this conversation.
No Milestone
4 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: tfgrid/circle_promotion#280
No description provided.