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

Create public website with user, maintainer, and developer docs #1722

Open
gino-m opened this issue Apr 10, 2024 · 0 comments
Open

Create public website with user, maintainer, and developer docs #1722

gino-m opened this issue Apr 10, 2024 · 0 comments
Labels
type: docs Technical and non-technical public documentation

Comments

@gino-m
Copy link
Collaborator

gino-m commented Apr 10, 2024

Proposed outline:

  • About Ground
    • Background
    • Goal, mission, vision
    • Licensing, community ownership
    • Current state and deployments
  • User's guides
    • For survey organizers
    • For data collectors
  • App publishers
    • System overview
    • Build, troubleshoot, test, deploy, publish Ground to Play Store
  • Contributors
    • Technical overview (architecture)
    • Getting started
    • Web and Android app arch, reference docs, coding and testing best practices
    • Same for Firebase (Authentication, Cloud Functions, Firestore and Storage
      organization and rules), Crashlytics
    • Contributing (creating issues, PRs, etc)
    • Code of conduct
  • Maintainers
    • Triaging, reviewing issues & PRs
    • Code of conduct
  • Working group
    • Roles, responsibilities, current members, link to code of conduct
    • Processes, incl decision making and planning, incl. life of a ticket (FR, bug, project, or
      other task)
    • Product and UX guidelines
  • Steering committee
    • Scope and roles, current members, link to code of conduct
    • Process for charter amendments or major strategic decisions
  • 2024 calendar (major events, WG and steering committee meetings)

@jcqli @amegantz @lecrabe please comment here and I'll update this outline accordingly.

@gino-m gino-m added web Angular implementation of Web UI type: docs Technical and non-technical public documentation labels Apr 10, 2024
@gino-m gino-m added this to the Community ownership milestone Apr 10, 2024
@gino-m gino-m changed the title Create public website with user, maintainers, and developer docs Create public website with user, maintainer, and developer docs Apr 10, 2024
@gino-m gino-m removed the web Angular implementation of Web UI label Apr 10, 2024
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: No status
Development

No branches or pull requests

1 participant