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

[Code health] Update developer documentation in Wiki #1446

Closed
gino-m opened this issue Jan 16, 2024 · 8 comments
Closed

[Code health] Update developer documentation in Wiki #1446

gino-m opened this issue Jan 16, 2024 · 8 comments
Labels
type: docs Technical and non-technical public documentation

Comments

@gino-m
Copy link
Collaborator

gino-m commented Jan 16, 2024

Most pages are woefully out of date; hiding the Wiki until we can update docs to latest.

@gino-m gino-m added the type: code health Improvements to readability or robustness of codebase label Jan 16, 2024
@gino-m gino-m added this to the 3) Launch milestone Jan 16, 2024
@gino-m gino-m added this to Ground Jan 16, 2024
@gino-m gino-m added type: docs Technical and non-technical public documentation and removed type: code health Improvements to readability or robustness of codebase labels Apr 22, 2024
@gis-wes
Copy link

gis-wes commented Oct 18, 2024

Would be nice to have a way to contribute to the wiki. Instructions did not work out of the box when onboarding.

@gino-m
Copy link
Collaborator Author

gino-m commented Oct 18, 2024

@gis-wes We're planning to move all docs to the website under /docs by EOY, at which point they'll be editable.

In the meantime, can you let us know which issues you've encountered and in which page and step? @rfontanarosa FYI

@gis-wes
Copy link

gis-wes commented Oct 18, 2024

@gino-m So far, my observations have been on "First Time Setup" in the dev guide. I've been keeping a log of any friction in the setup process at https://github.com/users/gis-wes/projects/1/views/3. Not a lot of detail at the moment. I'm getting into functionality now. I'll keep recording what I find. Is there an active community to ask questions when issues are encountered?

@gino-m
Copy link
Collaborator Author

gino-m commented Nov 5, 2024

So far, my observations have been on "First Time Setup" in the dev guide. I've been keeping a log of any friction in the setup process at https://github.com/users/gis-wes/projects/1/views/3. Not a lot of detail at the moment. I'm getting into functionality now. I'll keep recording what I find. Is there an active community to ask questions when issues are encountered?

@gis-wes Just back and ramping back up. This friction log is excellent, very helpful. (@amegantz @rfontanarosa FYI) We've just transitioned to community ownership, so there is still no public discussion forum. Open to suggestions on platforms to use for this.

@rfontanarosa
Copy link
Collaborator

rfontanarosa commented Nov 6, 2024

thank you @gis-wes, I've updated the guide yesterday (mainly the web-app part). reading your friction list, it should fix three or four of your points.

@gino-m
Copy link
Collaborator Author

gino-m commented Nov 6, 2024

Thanks @rfontanarosa for that. That will be helpful when we convert the wiki contents into a public website. Closing this since the requested updates were made.

@gino-m gino-m closed this as not planned Won't fix, can't repro, duplicate, stale Nov 6, 2024
@github-project-automation github-project-automation bot moved this to Done in Ground Nov 6, 2024
@gino-m gino-m closed this as completed Nov 6, 2024
@gino-m
Copy link
Collaborator Author

gino-m commented Nov 6, 2024

@gis-wes Any chance you'd like to file the remaining frictions / FRs as bugs in ground/ground-platform? Once we have the docs in the repro, would you be interested in taking some of those fixes on?

@gis-wes
Copy link

gis-wes commented Jan 24, 2025

@gino-m Sorry, got busy but I'm back now. I'll find what is remaining during my next install and file bugs.

Is there an inventory of existing functionality from a user standpoint? Would be glad to write docs while I walkthrough what exist. Wanted to catalog it before writing any feature requests for PRs I could submit. I've noticed a few gaps that I want to propose if they're actually missing.

Looks like the community driven docs are still a work-in-progress. Wondering how to contribute while I ramp up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Technical and non-technical public documentation
Projects
Status: Done
Development

No branches or pull requests

3 participants