docs: How to configure the `project_url` table

[fyliu]

Overview

We need some documentation to explain how project_url works in relation to project. This is especially true of the external_id field, which is not obvious that it's an id provided by an external service such as github.

Action Items

• [ ] create documentation

Resources/Instructions

• original comment

[ExperimentsInHonesty]

@fyliu

• Q1: Where do you want this information to go once we write a draft?
• Q2: Who is the audience for this documentation
• Q3: When will this information be accessed?

[fyliu]

@ExperimentsInHonesty This corresponds to a high level explanation for an end user setting up projects for an organization. But this is really at the API level so that a frontend client app developer will know how to integrate it into the app and how to guide the end user.

• Q1: Where do you want this information to go once we write a draft?

• An explanation page for the project "module" (maybe a file called docs/topics/project.md, where docs/topics/ contains all the high-level explanatory pages)

• Q2: Who is the audience for this documentation

• frontend client developers
• should the stakeholder labels be s:VRMS also?

• Q3: When will this information be accessed?

• during development of the corresponding frontend feature
• or when potential consumer of the API is evaluating our system