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

Documentation review #447

Merged
merged 45 commits into from Nov 9, 2023
Merged

Documentation review #447

merged 45 commits into from Nov 9, 2023

Conversation

mrshll1001
Copy link
Contributor

Related issues

Description

Summary is available at the forum: https://forum.openreferral.org/t/our-review-of-the-hsds-docs-is-available-for-comment/430

Merge checklist

  • Update the changelog

If you have edited any schema files:

  • Run hsds_schema.py to update datapackage.json and example files
  • Update the logical model page if relevant

Matt Marshall added 18 commits August 30, 2023 17:23
Began docs restructuring
1b79363
replaced publication formats page with serialization
65f3c29
Changes to docs structure re serialization
98922e7
Added guidance on where to find details of filenames for csv serializ…
4ffdc82 
…ation
Fixed broken links
a04b254
Began expanding identifiers page
5db8137
Began conformance section
3947468
reference section
8dc7baf
Mostly field guidance with some tidying of other reference material
9fc0ed3
Finished and refactored worked examples for field guidance page
ed30f71
Amended the descriptions of Page Schema properties in openapi.json fo…
64c16b2 
…r clarity
Removed references to OR UK from API Reference page, as this is handl…
8cc64c7 
…ed by OR UK docs
Tightened up language on API Reference
8f53be0
Tightened up the profiles specification
6554ffd
Further tightened the Profile specification
0e07342
Quick review and tidy
992b62c
Fixed link to UK profile docs. Whoops
ed79f33
Added pycache to gitignore. Overdue.
d8506a2
dan-odsc and others added 5 commits October 6, 2023 00:02
@dan-odsc
Update index.md
09d2f0c 
Updating as per this request from Greg - https://hyp.is/D38sIO4EEeqNudv3cKwHQA/docs.openreferral.org/en/latest/
@dan-odsc
Update index.md
58ea562 
Changes as per Greg request - https://hyp.is/rAsqbmFZEe6B8IdUc54pOA/docs.openreferral.org/en/latest/
@greggish
Update index.md
d8579d0 
Updated description of Technical Standups, Assemblies, and Summits
@greggish
Update use_cases.md
20744d1 
Just updated the Types of Use / User personas link from the old Google Doc to the new documentation section. 

We probably want to do more to this page but starting there.
@greggish
Update use_cases.md
65792a3 
I added a paragraph here that clarifies that 'database administrators' are our primary type of user, before then elaborating on the capacities that HSDS offers to them. 

Can you check my framing there to make sure it reads correctly and seems apt?
Matt Marshall and others added 19 commits October 19, 2023 10:33
Adjusted wording of service_at_location description in Core objects
ff1a0f7
Merge branch 'documentation-review' of github.com:openreferral/specif…
c55a7d1 
…ication into documentation-review
Moved ERDs to hsds/serialiaztion.md
59afd2d
@dan-odsc
Update hsds_faqs.md
a2ed2cb 
Main thing I'm not sure of is what to do re link to section that are due to change or dissapear once we merge the doc review branch?

For not I've linked to the doc review branch but suspect those links will need to be changed when we merge?
@dan-odsc
Update faq.md
4c77751 
For review
@dan-odsc
Update use_cases.md
abb3526
Moved some stray top-level docs files into an appropriate place
d106d2c
Moved credits to initiative folder to match with navbar
45e3a06
Tidy links
4abf86b
@mrshll1001
Merge pull request #473 from openreferral/dan-faqs
5ecc87a 
Dan faqs
Slight sentence massaging for readability
93346c2
@mrshll1001
Merge pull request #462 from openreferral/greggish-patch-3
bb2b3d9 
Greggish patch 3
Replaced absolute link with relative to ensure it plays nicely with b…
706cb3c 
…ranches
Fix merge conflict
679ad5b
Fix merge conflict
8227581
@mrshll1001
Merge pull request #466 from openreferral/dan-odsc-patch-1
7f1cca9 
Update use_cases.md
Fixed my own typo in use_case.md
c604742
@mrshll1001
Merge pull request #461 from openreferral/greggish-patch-2
4dd0bdf 
Update index.md
Merge branch 'documentation-review' of github.com:openreferral/specif…
e2e09a7 
…ication into documentation-review
@mrshll1001
Copy link
Contributor Author

I've made a few changes responding to the community, as well as integrating several smaller edits from @greggish and @dan-odsc which should go live when we press the green button on this.

@mrshll1001 mrshll1001 mentioned this pull request Nov 8, 2023
Open
@mrshll1001 mrshll1001 merged commit 51890e0 into 3.0 Nov 9, 2023
6 of 11 checks passed
@mrshll1001 mrshll1001 deleted the documentation-review branch November 9, 2023 14:32
@mrshll1001 mrshll1001 mentioned this pull request Nov 16, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dan-odsc dan-odsc Awaiting requested review from dan-odsc

Assignees
No one assigned
Labels
documentation Profiles tooling
Projects
Technical Tasks and Priorities
Status: Completed
Milestone
No milestone
3 participants
@mrshll1001 @dan-odsc @greggish