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

Use the Github Wiki for FAQ and general documentation #422

Open
carlhiggs opened this issue May 3, 2024 · 2 comments
Open

Use the Github Wiki for FAQ and general documentation #422

carlhiggs opened this issue May 3, 2024 · 2 comments
Labels
user process to document A process to be conducted by users that our documentation should detail

Comments

@carlhiggs
Copy link
Member

We should also consider moving the FAQ from the website (https://healthysustainablecities.github.io/software/#Frequently-Asked-Questions) to Github (e.g. https://github.com/global-healthy-liveable-cities/global-indicators/wiki) and use that as the central location for this and link to it. But, rather than use that particular Wiki site, we should perhaps start it in a new repository in the https://github.com/healthysustainablecities organisation where we will migrate our software to. In that way, we can document our longer term roadmap/plan.

The Wiki is recommended as 'a place in your repository to lay out the roadmap of your project, show the current status, and document software better, together.' Sounds like a useful idea for us moving forwards. This will reduce the text on the website itself, so it is more instructional and less overwhelming (as per @eugenrb feedback).

Lets discuss this in our spatial team meeting next week @global-healthy-liveable-cities/software-spatial

@carlhiggs carlhiggs added the enhancement New feature or request label May 3, 2024
@eugenrb
Copy link
Member

eugenrb commented May 3, 2024

I like this idea. I will try to join the next spatial team meeting, although it will be at 1 am. I still haven't been able to work on the software website mock, but I will be able to start working on this starting on the week of May 13th.

@gboeing
Copy link
Collaborator

gboeing commented May 3, 2024

+1 to moving the FAQ from the website to GitHub.

@carlhiggs carlhiggs added user process to document A process to be conducted by users that our documentation should detail and removed enhancement New feature or request labels May 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
user process to document A process to be conducted by users that our documentation should detail
Projects
None yet
Development

No branches or pull requests

3 participants