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

individuel Pages for all systems - not only affected ones #269

Open
MirMiz opened this issue Apr 20, 2023 · 3 comments
Open

individuel Pages for all systems - not only affected ones #269

MirMiz opened this issue Apr 20, 2023 · 3 comments

Comments

@MirMiz
Copy link
Contributor

MirMiz commented Apr 20, 2023

Is your feature request related to a problem? Please describe.
at the moment: cstate/hugo only creates pages for systems, which are currently affected by an incident.
clicking on a system's name (without incidents) on the index page forwards to the 404.html-page, with is showing a vague message like "doc not found OR no incident recorded OR url maybe wrong" (it's not the fault of the 404-page: he/she/it can't know for sure)
It would be more user-friendly, if more precise information could be displayed.

Describe the solution you'd like
rendering/creating page for all systems would be a solution for this problem.
_default/lists.html seems to be already prepared for this usecase: Lines 59ff formulate an if-clause to include the calmBeforeTheStorm-message. (however, as the pages for systems currently will only be rendered, if there are incidents, the calmBeforeTheStorm is never displayed) :(

Describe alternatives you've considered
i tried to create inndividual pages per system in a folder content/affected/. this kind of works. however, this would be some form of duplicate data storage, as the systems names are already defined in config.yml. (Furthermore, I wasn't able to display die incidents/issues belonging to the system on it's content/affected/-Page. -- if fixable, this might be an alternativ, though)

@mistermantas
Copy link
Member

This is an issue but..

this issue goes away when you create the first issue. So, in other words, this issue is not persistent. What's your use case that you have many empty categories/systems?

@MirMiz
Copy link
Contributor Author

MirMiz commented Apr 23, 2023

I want to show the user the extended system's description mentioned in #270 . however, if the site is not rendert, the extended description is not shown.
in the description we placed additional link to tickettools, selfservice and a small component intro.
we plan to delete older incidents after a couple of weeks.

I want to have the same "look and feel" for all systems the user clicks (regardless if theres currently an incident or not)

@MirMiz
Copy link
Contributor Author

MirMiz commented Apr 23, 2023

a possible - but a little bit tedious (if not done by python ;)) - solution without changing cstate looks like this:
maybe you could add this to the Wiki, @mistermantas

create for each system a folder:
content/affected/SYSTEMSNAME and place a _index.md file in there (note the _) with the content

---
title: Title of the system
---

the SYSTEMSNAME needs to exaclty match the URL, which is shown in the components list on the main page. just copy it from there.
(if you want to create it yourself: it is generated from systems-array in config.yml like this: $system.title | urlize, so the url-safe version of the name. i.e. Spaces and most other special chars get replaced by '-'. However, '+' and '_' won't be replaced)


Example:
config.yml:

    - name: Media Proxy
      description: This is the service responsible for serving images, audio, and video. It is reliant on our CDN.
      category: Uncategorized

WebUI:
grafik
-> affected/media-proxy/ (note: ' ' -> '-')

Therefore:
create a folder affected/media-proxy/ and place a file _index.md in there with the following content:

---
title: Media Proxy
---

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants