Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENH: add incident reports section (Issue #90) #92

Open
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from

Conversation

anonmouse1
Copy link

@anonmouse1 anonmouse1 commented Sep 24, 2022

As requested in issue #90, a dedicated section has been added for incident reports.
Changes:

  • Reports section effectively split in two(reports.md removed), at a top level there now exists pages for either "Board Reports"(created board-reports.md) or "Incident reports"(created incident-reports.md)
  • Board reports should now be stored in the dedicated folder: board-reports/_posts instead of the previous _post directory
  • _posts directory in root folder has been cleared out and historic Board Reports that were stored there have now been migrated to board-reports/_posts
  • Incident reports should be stored in the dedicated folder: incident-reports/_posts (currently empty)
  • The home page now displays 6 of the most recent board and incident reports
  • A link to the board reports and incident reports archive now exists on the home page
  • some code syntax updated in index file according to Prettier add-on standards
  • *Please note in images below, incident reports has been populated with sample files for testing purposes. A placeholder incident report file has been stored in this folder and can be removed when actual incident reports are uploaded.
    incident-reports-owg-website
    owg-website-home-incident-reports-update

@pnorman pnorman self-requested a review September 25, 2022 19:23
@pnorman
Copy link
Collaborator

pnorman commented Sep 28, 2022

I need to give this a proper review, but a couple things stand out from the preview and description

  • The current reports are not board reports, they are monthly reports
  • We already have two incident reports with 2022/07/20/post-mortem.md and 2022/07/24/standard-tile-layer.md. These need moving to the incident reports, with redirects, because existing URLs need to still work
  • The incident reports shouldn't be date based (e.g. August 2022) as we don't expect to produce them regularly.

@Joanneeve73

This comment was marked as spam.

@anonmouse1
Copy link
Author

I need to give this a proper review, but a couple things stand out from the preview and description

  • We already have two incident reports with 2022/07/20/post-mortem.md and 2022/07/24/standard-tile-layer.md. These need moving to the incident reports, with redirects, because existing URLs need to still work

Just for clarification here regarding URL redirection and storage of the incident-report files:

  • "need moving to incident reports" : would it suffice to store these files in the dedicated folder I have created for these incidents (incident-reports in root folder) and leave the existing files also in the current 2022/07/20 and 2022/07/24 folders also ? When a site member is storing the incident reports in future, will they be continuing to store them in the 2022/XX/XX folder or will the process be changed so that they are now only stored in the dedicated folder ( incident-reports)?
  • regarding existing URLs needing to work: are you referring to URLs embedded in the current incident reports or are you indicating that the incident report files themselves are referenced elsewhere and physically moving the files would then break these URL references ?

@openstreetmap openstreetmap deleted a comment from Joanneeve73 Oct 1, 2022
@anonmouse1
Copy link
Author

I need to give this a proper review, but a couple things stand out from the preview and description

  • We already have two incident reports with 2022/07/20/post-mortem.md and 2022/07/24/standard-tile-layer.md. These need moving to the incident reports, with redirects, because existing URLs need to still work

Just for clarification here regarding URL redirection and storage of the incident-report files:

  • "need moving to incident reports" : would it suffice to store these files in the dedicated folder I have created for these incidents (incident-reports in root folder) and leave the existing files also in the current 2022/07/20 and 2022/07/24 folders also ? When a site member is storing the incident reports in future, will they be continuing to store them in the 2022/XX/XX folder or will the process be changed so that they are now only stored in the dedicated folder ( incident-reports)?
  • regarding existing URLs needing to work: are you referring to URLs embedded in the current incident reports or are you indicating that the incident report files themselves are referenced elsewhere and physically moving the files would then break these URL references ?

@pnorman Any thoughts on the above queries ?

@pnorman
Copy link
Collaborator

pnorman commented Oct 20, 2022

  • "need moving to incident reports" : would it suffice to store these files in the dedicated folder I have created for these incidents (incident-reports in root folder) and leave the existing files also in the current 2022/07/20 and 2022/07/24 folders also ? When a site member is storing the incident reports in future, will they be continuing to store them in the 2022/XX/XX folder or will the process be changed so that they are now only stored in the dedicated folder ( incident-reports)?

All incident reports should only be stored in the new folder.

The existing ones should be redirected, not duplicated.

regarding existing URLs needing to work: are you referring to URLs embedded in the current incident reports or are you indicating that the incident report files themselves are referenced elsewhere and physically moving the files would then break these URL references ?

Links to the reports need to remain unbroken.

@pnorman pnorman removed their request for review December 3, 2022 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants