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.

Sign up for GitHub

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

Jump to bottom

Create add-missing-documentation.md #430

Merged
merged 2 commits into from
Nov 8, 2024
Merged

Create add-missing-documentation.md #430

merged 2 commits into from
Nov 8, 2024

Conversation

shmonks
Copy link
Member

@shmonks shmonks commented Nov 6, 2024 •
edited
Loading

New issue template for team members who find that our repo lacks sufficient information on a topic, and that information might be necessary/useful for developers working on or with PeopleDepot

What changes did you make?

  • New issue template

Why did you make the changes (we will use this info to test)?

  • To enable team members to record missing documentation in such a way that the missing information can subsequently be added to the documentation by another team member

@shmonks
Create add-missing-documentation.md
6a395ef 
New issue template for team members who find that our repo lacks sufficient information on a topic which might be necessary/useful for developers working on/with PeopleDepot
@shmonks shmonks added s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours feature: docs: PD team documentation documentation on PD team processes and architecture, etc. complexity: small All steps are laid out in detail so that someone new to the project can work on it labels Nov 6, 2024
@shmonks shmonks self-assigned this Nov 6, 2024
@shmonks shmonks removed s: PD team stakeholder: People Depot Team size: 0.25pt Can be done in 0.5-1.5 hours feature: docs: PD team documentation documentation on PD team processes and architecture, etc. complexity: small All steps are laid out in detail so that someone new to the project can work on it labels Nov 6, 2024
@ExperimentsInHonesty ExperimentsInHonesty merged commit 3849830 into main Nov 8, 2024
1 check passed
@ExperimentsInHonesty ExperimentsInHonesty deleted the shmonks-patch-1 branch November 8, 2024 01:59
fyliu pushed a commit that referenced this pull request Nov 12, 2024
@shmonks @pre-commit-ci @fyliu
Create add-missing-documentation.md (#430)
2b81e8b 
* Create add-missing-documentation.md

New issue template for team members who find that our repo lacks sufficient information on a topic which might be necessary/useful for developers working on/with PeopleDepot

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
ethanstrominger added a commit to ethanstrominger/peopledepot that referenced this pull request Dec 19, 2024
@ethanstrominger
Squashed commit of the following:
f0bc01b 
commit 0d70d8f
Author: Ethan Strominger <[email protected]>
Date:   Wed Dec 18 11:42:21 2024 -0500

    Update graphviz

commit 775d753
Author: Ethan Strominger <[email protected]>
Date:   Sun Dec 1 17:25:56 2024 -0500

    Modify to tricker pre-commit

commit c75db16
Author: Ethan Strominger <[email protected]>
Date:   Sun Dec 1 17:23:16 2024 -0500

    Fix trailing whitespace

commit 401607f
Author: Bonnie Wolfe <[email protected]>
Date:   Mon Nov 25 14:29:04 2024 -0800

    Update issue templates

    Updated Update table issue template

commit 5bf8278
Author: Bonnie Wolfe <[email protected]>
Date:   Mon Nov 18 14:40:24 2024 -0800

    Update issue templates

    Added another action item to the update table issue template

commit e3441c8
Author: del9ra <[email protected]>
Date:   Sun Oct 27 21:36:27 2024 -0400

    feat: add model: user_status_type

commit db91e3e
Author: Ethan-Strominger <[email protected]>
Date:   Wed Nov 13 15:17:54 2024 -0500

    Provide options to speed up test script (hackforla#415)

    * Add pytest-xdist for multi CPU parallel testing
    * Update instructions
    * Fix createsuperuser.sh
    * Add shell.sh, remove unneeded scripts

commit b62f2ea
Author: dmartin4820 <[email protected]>
Date:   Sun Oct 6 18:28:54 2024 -0700

    docs: update initial seed data section for clarity

commit 7e07358
Author: dmartin4820 <[email protected]>
Date:   Sun Oct 6 18:19:32 2024 -0700

    feat: add seed data: url_type

commit 82f02d8
Author: dmartin4820 <[email protected]>
Date:   Sun Oct 6 17:57:49 2024 -0700

    feat: add endpoints: url_type

commit 6bbd43d
Author: dmartin4820 <[email protected]>
Date:   Sun Oct 6 17:42:17 2024 -0700

    feat: register admin: url_type

commit 4d26ed6
Author: dmartin4820 <[email protected]>
Date:   Sun Oct 6 17:35:57 2024 -0700

    feat: add model: url_type

commit 36007fd
Author: dmartin4820 <[email protected]>
Date:   Tue Sep 17 22:30:47 2024 -0700

    docs(add-model): create tips for many-to-many relationships

commit 47dc303
Author: dmartin4820 <[email protected]>
Date:   Mon Sep 16 19:55:19 2024 -0700

    feat: add many-to-many relationship to project: Sdg

commit 71b4ac9
Author: Bonnie Wolfe <[email protected]>
Date:   Mon Nov 11 15:16:15 2024 -0800

    Update issue templates

    removed typos

commit 2457784
Author: Bonnie Wolfe <[email protected]>
Date:   Mon Nov 11 15:08:14 2024 -0800

    Update issue templates

    updated template

commit c698f9b
Author: Nicole Dubin <[email protected]>
Date:   Mon Nov 11 14:39:20 2024 -0700

    Update issue templates, added Change Schema template

commit 2b81e8b
Author: Sarah Monks, PhD <[email protected]>
Date:   Thu Nov 7 17:59:16 2024 -0800

    Create add-missing-documentation.md (hackforla#430)

    * Create add-missing-documentation.md

    New issue template for team members who find that our repo lacks sufficient information on a topic which might be necessary/useful for developers working on/with PeopleDepot

    * [pre-commit.ci] auto fixes from pre-commit.com hooks

    for more information, see https://pre-commit.ci

    ---------

    Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

commit d7ec7c3
Author: Bonnie Wolfe <[email protected]>
Date:   Mon Nov 4 15:39:28 2024 -0800

    Update issue templates

    Updated update table template

commit cd10399
Author: Bonnie Wolfe <[email protected]>
Date:   Mon Nov 4 15:24:26 2024 -0800

    Update issue templates

    updated the update template

commit e97e432
Author: Nicole Dubin <[email protected]>
Date:   Mon Nov 4 15:56:00 2024 -0700

    Update issue templates

    Added new template for changing tables

commit bd1cac1
Author: Sarah Monks, PhD <[email protected]>
Date:   Wed Oct 23 15:15:04 2024 -0700

    Revise issue templates (hackforla#407)

    * Adding complexity label

    * Adding missing labels

    * Adding labels to new issue templates

    * Add missing labels to new issue template

    * Add missing labels to new issue templates

    * Add missing labels to new issue template

    * Add missing labels to new issue templates

    * Add missing labels to new issue templates

    * Add missing labels to new issue templates

    * Add missing labels to new issue templates

    * Add missing labels to new issue templates

    * Add missing labels to new issue templates

    * Add missing labels to new issue templates

    * Add missing labels to new issue templates

    * Add missing labels to new issue templates

    * Add missing labels to new issue templates

    * Apply suggestions from code review

    I added and removed some labels

    ---------

    Co-authored-by: Bonnie Wolfe <[email protected]>

commit 5e3439f
Author: Fang Yi Liu <[email protected]>
Date:   Thu Oct 17 00:26:39 2024 -0700

    fix link to Working with Docker

commit 42546ef
Author: Fang Yi Liu <[email protected]>
Date:   Thu Oct 17 00:15:50 2024 -0700

    fix link to How-to Guides in Contributing index

commit eda6524
Author: Sarah Monks, PhD <[email protected]>
Date:   Wed Oct 16 16:43:04 2024 -0700

    Corrected typo

commit 9668ea3
Author: Sarah Monks, PhD <[email protected]>
Date:   Wed Oct 16 16:41:58 2024 -0700

    Corrected typo

commit 344986b
Author: Fang Yi Liu <[email protected]>
Date:   Thu Oct 17 00:16:20 2024 -0700

    list tools in alphabetical order

commit ffd3659
Author: Sarah Monks, PhD <[email protected]>
Date:   Wed Oct 16 16:29:12 2024 -0700

    Updated link to Prioritized Backlog and a few typos corrected

commit 602f9a7
Author: Fang Yi Liu <[email protected]>
Date:   Tue Sep 3 12:23:55 2024 -0700

    fix link in contributing index.md

commit 0326d67
Author: Fang Yi Liu <[email protected]>
Date:   Sat Aug 24 01:50:33 2024 -0700

    fix local dev api url in add model guide

commit 1413003
Author: Fang Yi Liu <[email protected]>
Date:   Tue Jul 23 16:43:11 2024 -0700

    move how-to and tools to contributing

commit 44cf40f
Author: Fang Yi Liu <[email protected]>
Date:   Fri Jul 26 16:09:30 2024 -0700

    update team.md with slack channel link

commit 54cd363
Author: Fang Yi Liu <[email protected]>
Date:   Fri Jul 26 11:44:52 2024 -0700

    update links to contributing pages

commit c7a29d0
Author: Fang Yi Liu <[email protected]>
Date:   Fri Jul 26 16:10:16 2024 -0700

    update titles for contributing pages

commit 789f2a0
Author: Fang Yi Liu <[email protected]>
Date:   Thu Jul 25 11:12:42 2024 -0700

    move pre-commit section to the dev environment page

commit 03abc8b
Author: Fang Yi Liu <[email protected]>
Date:   Tue Jul 23 16:50:01 2024 -0700

    remove all header numbering

    These can be auto-generated if needed

commit a889b08
Author: Fang Yi Liu <[email protected]>
Date:   Fri Jul 26 11:41:31 2024 -0700

    split CONTRIBUTING.md from contributing/index.md

    CONTRIBUTING.md will be a simplified page that links to the mkdocs contributing
    page.

commit 02d0116
Author: Fang Yi Liu <[email protected]>
Date:   Thu Oct 3 10:12:30 2024 -0700

    move docker section into tools/docker.md

commit f307431
Author: Fang Yi Liu <[email protected]>
Date:   Tue Jul 23 01:26:06 2024 -0700

    split CONTRIBUTING.md into smaller files

commit d99d625
Author: Fang Yi Liu <[email protected]>
Date:   Thu Sep 19 13:08:17 2024 -0700

    scripts: add rebase_migration script

commit d9c5e97
Author: Fang Yi Liu <[email protected]>
Date:   Thu Sep 5 15:47:48 2024 -0700

    update Docker syntax

    - compose file no longer uses versioning
    - Dockerfile env vars use = signs

commit 30e7f98
Author: Ethan Strominger <[email protected]>
Date:   Mon Oct 7 20:15:43 2024 -0400

    Migration scripts

commit b91960e
Author: Ethan Strominger <[email protected]>
Date:   Mon Oct 7 20:01:10 2024 -0400

    Issue 403 make project optional for user_permissions

commit d07d731
Author: Bonnie Wolfe <[email protected]>
Date:   Mon Oct 7 14:54:27 2024 -0700

    Update issue templates

commit 6304e87
Author: Bonnie Wolfe <[email protected]>
Date:   Mon Oct 7 14:51:22 2024 -0700

    Update issue templates

commit 3b2a987
Author: Bonnie Wolfe <[email protected]>
Date:   Thu Oct 3 17:38:42 2024 -0700

    Update issue templates

commit e58103b
Author: del9ra <[email protected]>
Date:   Tue Sep 17 14:57:12 2024 -0400

    added seed data

commit 14df6e9
Author: del9ra <[email protected]>
Date:   Tue Sep 17 14:42:11 2024 -0400

    feat: add model and  endpoints: soc_major

commit b2398e1
Author: Ethan-Strominger <[email protected]>
Date:   Thu Sep 19 18:06:29 2024 -0400

    Implement user_permissions model, api, and test (hackforla#342)

    * Implemented user_permissions model, API, and test
    * Added rank field to permission_type and modified the initial migration file

    Note: people who already have the old initial data will need to roll back and re-apply the migration

commit edee44d
Author: Fang Yi Liu <[email protected]>
Date:   Tue Jul 9 16:57:09 2024 -0700

    docs: how to switch back to debian docker image

commit a915a66
Author: Fang Yi Liu <[email protected]>
Date:   Sun Jun 9 21:52:19 2024 -0700

    fix: make everybody build amd64 docker images

    This is aimed at Mac user running on Apple Silicon. It standardizes the image platform so there won't be Mac-specific
    issues that aren't also happening in Linux.

commit 658264a
Author: Fang Yi Liu <[email protected]>
Date:   Wed Jun 5 10:48:15 2024 -0700

    fix: set minimum version for graphviz

    The Alpine repo provides only the latest version of packages. The
    previous release is purged when a new one is uploaded, causing docker
    builds to fail. To work around this, I'm setting a minimum version to
    the minor version. It will still fail if graphviz decides to release
    v9.1, but that's possibly a breaking change that we should re-test
    anyway. See the official documentation for syntax.
    https://wiki.alpinelinux.org/wiki/Alpine_Package_Keeper#Advanced_APK_Usage

commit a833df9
Author: Fang Yi Liu <[email protected]>
Date:   Thu Apr 4 10:21:16 2024 -0700

    switch to alpine image

    Somehow, the graph_model command can't generate png even though I
    installed Roboto font manually. But calling dot separately works, so
    that's what's being done now.

commit b3577d5
Author: AzaniaBG <[email protected]>
Date:   Sun Mar 31 09:34:29 2024 -0700

    Rename technology table to stack_element and add element_type FK

    This deletes and recreates the table as new, which is not ideal, but acceptable
    since we're still in development and not losing data from the migration. It's
    possible to rename and add FK in separate migrations but it would take 3 of
    them.

commit 475d6bc
Author: Fang Yi Liu <[email protected]>
Date:   Thu Sep 5 18:17:33 2024 -0700

    chore: update graphviz version

commit 571367b
Author: Fang Yi Liu <[email protected]>
Date:   Thu Jul 18 12:27:35 2024 -0700

    tests: run migration check as test

commit 092e68a
Author: Fang Yi Liu <[email protected]>
Date:   Mon May 13 16:08:36 2024 -0700

    docs: project structure

commit c410944
Author: dmartin4820 <[email protected]>
Date:   Tue Aug 20 20:19:22 2024 -0700

    docs(contributing): add relative path starting from ./app to step 2.3.2

commit beeaeec
Author: dmartin4820 <[email protected]>
Date:   Tue Aug 20 20:16:52 2024 -0700

    docs(add-model): import model to views.py step

commit 89cd778
Author: dmartin4820 <[email protected]>
Date:   Tue Aug 20 19:56:13 2024 -0700

    feat: add seed data: check_type

commit 2f99c60
Author: dmartin4820 <[email protected]>
Date:   Tue Aug 20 19:21:05 2024 -0700

    feat: add endpoints: check_type

commit fe84802
Author: dmartin4820 <[email protected]>
Date:   Tue Aug 20 18:46:12 2024 -0700

    feat: register admin: check_type

commit 3b386f7
Author: dmartin4820 <[email protected]>
Date:   Tue Aug 20 18:40:15 2024 -0700

    feat: add model: check_type

commit 9e93761
Author: Fang Yi Liu <[email protected]>
Date:   Thu Jun 6 14:23:51 2024 -0700

    docs(add-model): add line numbers for code listings

commit 9f13131
Author: Fang Yi Liu <[email protected]>
Date:   Mon Jun 10 09:29:46 2024 -0700

    docs(add-model): adjust annotations

    Repositioned and combined a couple of them.

commit f6eee6d
Author: Fang Yi Liu <[email protected]>
Date:   Fri May 17 16:49:45 2024 -0700

    docs(mkdocs): add syntax examples

commit 1108d73
Author: Fang Yi Liu <[email protected]>
Date:   Wed Jan 17 15:49:52 2024 -0800

    docs: fix number list formatting

commit d198a0e
Author: Fang Yi Liu <[email protected]>
Date:   Thu Dec 21 15:33:00 2023 -0800

    docs: convert contributing to use mkdocs constructs

commit 82a9fce
Author: Fang Yi Liu <[email protected]>
Date:   Tue Dec 19 22:31:57 2023 -0800

    docs: add model page tweaks

commit 253ae8d
Author: Fang Yi Liu <[email protected]>
Date:   Tue Dec 19 21:43:52 2023 -0800

    docs: fix internal links

commit c3282ae
Author: Fang Yi Liu <[email protected]>
Date:   Tue Dec 19 13:24:40 2023 -0800

    docs: clean up add model page using mkdocs constructs

commit d1d7e65
Author: Fang Yi Liu <[email protected]>
Date:   Mon Jun 17 10:57:19 2024 -0700

    add reverse function to permissiontype initial data migration

commit dcabb0a
Author: Fang Yi Liu <[email protected]>
Date:   Fri Aug 9 16:21:01 2024 -0700

    fix contributing link to add model and api endpoints

commit 348fbb3
Author: Nayan Bhatt <[email protected]>
Date:   Fri Aug 9 22:01:23 2024 +0530

    Add seed data permission type 278 (hackforla#303)

commit a2053c1
Author: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date:   Mon Jul 1 21:49:28 2024 +0000

    [pre-commit.ci] pre-commit autoupdate

    updates:
    - [github.com/asottile/pyupgrade: v3.15.2 → v3.16.0](asottile/pyupgrade@v3.15.2...v3.16.0)
    - [github.com/adamchainz/django-upgrade: 1.16.0 → 1.19.0](adamchainz/django-upgrade@1.16.0...1.19.0)
    - [github.com/adamchainz/blacken-docs: 1.16.0 → 1.18.0](adamchainz/blacken-docs@1.16.0...1.18.0)
    - [github.com/pycqa/flake8: 7.0.0 → 7.1.0](PyCQA/flake8@7.0.0...7.1.0)
    - [github.com/PyCQA/bandit: 1.7.8 → 1.7.9](PyCQA/bandit@1.7.8...1.7.9)
    - [github.com/astral-sh/ruff-pre-commit: v0.4.3 → v0.5.0](astral-sh/ruff-pre-commit@v0.4.3...v0.5.0)

commit ed6d091
Author: Fang Yi Liu <[email protected]>
Date:   Thu Aug 8 14:42:12 2024 -0700

    Add cognito authentication and API endpoint pages

    This is a direct copy from the project wiki. We will modify them
    separately.

commit 272af87
Author: Ethan-Strominger <[email protected]>
Date:   Thu Aug 8 18:48:15 2024 -0400

    Add reference to Table and API instructions in CONTRIBUTING.md. (hackforla#332)

commit 36734de
Author: Fang Yi Liu <[email protected]>
Date:   Fri Aug 2 11:47:32 2024 -0700

    docs: Project GitHub actions hackforla#285 (hackforla#294)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ExperimentsInHonesty ExperimentsInHonesty ExperimentsInHonesty approved these changes

Assignees

@shmonks shmonks

Labels
None yet
Projects
P: PD: Project Board
Status: ✅Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Epic: collect needed documentation
2 participants
@shmonks @ExperimentsInHonesty