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

Fix documentation confusion about HEAD-SOUR-DATA #553

Merged
merged 6 commits into from
Oct 8, 2024
Merged

Fix documentation confusion about HEAD-SOUR-DATA #553

merged 6 commits into from
Oct 8, 2024

Conversation

dthaler
Copy link
Collaborator

@dthaler dthaler commented Oct 2, 2024

  • Make HEAD.SOUR.DATA wording consistent between two places in spec
  • Deprecate HEAD.SOUR.DATA in favor of just using HEAD.SOUR.NAME

Fixes #549

@dthaler2
Deprecate HEAD.SOUR.DATA
4e6ca65 
Signed-off-by: Dave Thaler <[email protected]>
@dthaler
Copy link
Collaborator Author

dthaler commented Oct 8, 2024

Approved during GEDCOM Steering Committee meeting

@tychonievich tychonievich merged commit 7e683d5 into FamilySearch:main Oct 8, 2024
1 check passed
@dthaler dthaler deleted the head-sour-data branch October 8, 2024 16:38
dthaler added a commit that referenced this pull request Oct 22, 2024
@github-actions @tychonievich
@dthaler @dthaler2 @cdhorn @dstathis @elyoh
Merge main into v7.1 (#556)
36e2ad3 
* Update extracted files (#443)

Co-authored-by: Luther Tychonievich <[email protected]>

* decribe branches in README.md (#451)

* decribe branches in README.md

* Update README.md

Co-authored-by: Dave Thaler <[email protected]>

---------

Co-authored-by: Dave Thaler <[email protected]>

* Add contact info to auto-generated YAML files (#454)

Per discussion in steering committee meeting 2024-04-04, using <https://gedcom.io/community/> as the contact info because that page describes various means of contact and is expected to be updated from time to time as means of contact change.

* Add CI/CD workflow to validate YAML files (#457)

* Add CI/CD workflow to validate YAML files

Signed-off-by: Dave Thaler <[email protected]>

* Update YAML files to resolve yamllint errors

Signed-off-by: Dave Thaler <[email protected]>

* Update .github/workflows/validate-yaml.yml

* Update .github/workflows/validate-yaml.yml

---------

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* yamllint is recursive (#460)

Avoid validating the same file multiple times

https://github.com/FamilySearch/GEDCOM/actions/runs/8838156091/job/24268618756
under "Validate YAML" shows multiple occurences of files under
.github/workflow since .github and .github/workflow are both passed to
yamllint

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Add Separation event (#459)

* Add Separation event

* Remove FS API reference

* Fix workflow (#462)

https://github.com/FamilySearch/GEDCOM/actions/runs/9044561163 failure
reports: "The workflow is not valid.
.github/workflows/propagate-main-to-v7.1.yml (Line: 18, Col: 3): The
identifier 'merge-to-v7.1' is invalid. IDs may only contain alphanumeric
characters, '_', and '-'. IDs must start with a letter or '_' and and
must be less than 100 characters."

This PR therefore removes the '.' that is causing the failure.

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Track request for Separated as a future FAM attribute (#469)

Related to PR #459 which tracks the separation event

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Fix reference to FilePath data type (#466)

Fixes #465

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Typo in README.md (#472)

* Add the meaning of WWW (#480)

* Add the meaning of WWW

Previously (in both 5.5.1 and 7.0.0–7.0.14) `WWW` was defined only by the type of is payload. This is an attempt to fix that without invalidating any existing files.

Resolves #476

* Update specification/gedcom-3-structures-3-meaning.md

Co-authored-by: Dave Thaler <[email protected]>

---------

Co-authored-by: Dave Thaler <[email protected]>

* Remove substructure-specific extension wording (#481)

Resolves #478

* Add some possible additional family events for consideration (#479)

Co-authored-by: Luther Tychonievich <[email protected]>

* Clarify no-FORM PLACs (#487)

Resolves #486

* Define "principle date" (#492)

* Define "principle date"

As pointed out in #488 and #490, the definition of DATE includes the vague phrase "principle date" which could use some clarification. This is my effort to provide that clarification.

Note, if competing definitions of the principle date in these contexts exists then this suggestion could be seen as backwards-incompatible and may need to be reworded as a non-normative recommendation or note. That said, I'm not aware of any conflicting definitions.

Resolves #490

* typos

* typo

* Update extracted files (#485)

Co-authored-by: Luther Tychonievich <[email protected]>

* Clarify nickname (#482)

* Clarify nickname

Add additional clarification to nickname, explaining the word's meaning in English which is not shared by several European countries. See [this comment](#473 (comment)) and the rest of issue #473 for more on why this clarification is needed.

Although #473's discussion covers many more topics, if we go back to the title and first question in the issue I think this resolves #473.

* Update specification/gedcom-3-structures-3-meaning.md

* Change recommendation

* Update specification/gedcom-3-structures-3-meaning.md

* Update specification/gedcom-3-structures-3-meaning.md

---------

Co-authored-by: Dave Thaler <[email protected]>

* Update extracted files (#501)

Co-authored-by: Luther Tychonievich <[email protected]>

* Restore 3.0's definition of jurisdiction (#506)

* Restore 3.0's definition of jurisdiction

Restored the definition of "jurisdiction" that was present in version 3.0.

Resolved #496

* Update specification/gedcom-3-structures-3-meaning.md

Additional examples and less proscriptive text

* Update extracted files (#508)

Co-authored-by: Luther Tychonievich <[email protected]>

* Increase largest PLAC example (#514)

* Increase largest PLAC example

resolves #512

* Update specification/gedcom-3-structures-3-meaning.md

* Update extracted files (#515)

Co-authored-by: Luther Tychonievich <[email protected]>

* Fix validate-yaml warnings (#513)

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>
Co-authored-by: Luther Tychonievich <[email protected]>

* Update changelog.md (#525)

* Update changelog.md

We've been making changes without updating the changelog. This summarizes the changes since v7.14 was released.

* Update changelog.md

* Update changelog.md

---------

Co-authored-by: Dave Thaler <[email protected]>

* EXID.TYPE for BillionGraves.com and WikiTree identifiers (#540)

* EXID.TYPE for BillionGraves.com and WikiTree identifiers

Fixes #539

* Update exid-types.json

Co-authored-by: Luther Tychonievich <[email protected]>

* Apply suggestions from code review

Co-authored-by: Luther Tychonievich <[email protected]>

---------

Co-authored-by: Dave Thaler <[email protected]>
Co-authored-by: Luther Tychonievich <[email protected]>

* v7.0.15 release (#537)

Co-authored-by: Dave Thaler <[email protected]>

* Update exid-types.json (#543)

* Update exid-types.json

Resolve incorrect URIs as noted in #539

* move /name

* move /name

* move /name

* move /name

* Clarify a deprecation (#547)

* Update extracted files (#542)

Co-authored-by: Dave Thaler <[email protected]>

* Fix documentation confusion about HEAD-SOUR-DATA (#553)

* Make HEAD.SOUR.DATA wording consistent between two places in spec

Signed-off-by: Dave Thaler <[email protected]>

* Deprecate HEAD.SOUR.DATA

Signed-off-by: Dave Thaler <[email protected]>

* Update specification/gedcom-3-structures-1-organization.md

* Update specification/gedcom-3-structures-3-meaning.md

* Update specification/gedcom-3-structures-3-meaning.md

---------

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Add note about blank payloads (#554)

* Add note about blank payloads

Based on discussion in issue #495

Signed-off-by: Dave Thaler <[email protected]>

* Update specification/gedcom-3-structures-1-organization.md

* Update specification/gedcom-3-structures-1-organization.md

* Update specification/gedcom-3-structures-1-organization.md

---------

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Always quote tags (#560)

* Update generate-files to use a PAT (#557)

* Fix names of workflows
* Make generate-files use a PAT so that validate-yaml will run

The PAT is already generated and configured in the repository secrets

Fixes #503

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Update extracted files (#555)

Co-authored-by: Dave Thaler <[email protected]>

---------

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Luther Tychonievich <[email protected]>
Co-authored-by: Luther Tychonievich <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>
Co-authored-by: Christopher Horn <[email protected]>
Co-authored-by: Dylan Stephano-Shachter <[email protected]>
Co-authored-by: elyoh <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>
dthaler added a commit that referenced this pull request Nov 5, 2024
@github-actions @tychonievich
@dthaler @dthaler2 @cdhorn @dstathis @elyoh
Merge main into v7.1 (#563)
1584f5b 
* Update extracted files (#443)

Co-authored-by: Luther Tychonievich <[email protected]>

* decribe branches in README.md (#451)

* decribe branches in README.md

* Update README.md

* Add contact info to auto-generated YAML files (#454)

Per discussion in steering committee meeting 2024-04-04, using <https://gedcom.io/community/> as the contact info because that page describes various means of contact and is expected to be updated from time to time as means of contact change.

* Add CI/CD workflow to validate YAML files (#457)

* Add CI/CD workflow to validate YAML files

Signed-off-by: Dave Thaler <[email protected]>

* Update YAML files to resolve yamllint errors

Signed-off-by: Dave Thaler <[email protected]>

* Update .github/workflows/validate-yaml.yml

* Update .github/workflows/validate-yaml.yml

---------

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* yamllint is recursive (#460)

Avoid validating the same file multiple times

https://github.com/FamilySearch/GEDCOM/actions/runs/8838156091/job/24268618756
under "Validate YAML" shows multiple occurences of files under
.github/workflow since .github and .github/workflow are both passed to
yamllint

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Add Separation event (#459)

* Add Separation event

* Remove FS API reference

* Fix workflow (#462)

https://github.com/FamilySearch/GEDCOM/actions/runs/9044561163 failure
reports: "The workflow is not valid.
.github/workflows/propagate-main-to-v7.1.yml (Line: 18, Col: 3): The
identifier 'merge-to-v7.1' is invalid. IDs may only contain alphanumeric
characters, '_', and '-'. IDs must start with a letter or '_' and and
must be less than 100 characters."

This PR therefore removes the '.' that is causing the failure.

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Track request for Separated as a future FAM attribute (#469)

Related to PR #459 which tracks the separation event

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Fix reference to FilePath data type (#466)

Fixes #465

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Typo in README.md (#472)

* Add the meaning of WWW (#480)

* Add the meaning of WWW

Previously (in both 5.5.1 and 7.0.0–7.0.14) `WWW` was defined only by the type of is payload. This is an attempt to fix that without invalidating any existing files.

Resolves #476

* Update specification/gedcom-3-structures-3-meaning.md

Co-authored-by: Dave Thaler <[email protected]>

---------

Co-authored-by: Dave Thaler <[email protected]>

* Remove substructure-specific extension wording (#481)

Resolves #478

* Add some possible additional family events for consideration (#479)

Co-authored-by: Luther Tychonievich <[email protected]>

* Clarify no-FORM PLACs (#487)

Resolves #486

* Define "principle date" (#492)

* Define "principle date"

As pointed out in #488 and #490, the definition of DATE includes the vague phrase "principle date" which could use some clarification. This is my effort to provide that clarification.

Note, if competing definitions of the principle date in these contexts exists then this suggestion could be seen as backwards-incompatible and may need to be reworded as a non-normative recommendation or note. That said, I'm not aware of any conflicting definitions.

Resolves #490

* typos

* typo

* Update extracted files (#485)

Co-authored-by: Luther Tychonievich <[email protected]>

* Clarify nickname (#482)

* Clarify nickname

Add additional clarification to nickname, explaining the word's meaning in English which is not shared by several European countries. See [this comment](#473 (comment)) and the rest of issue #473 for more on why this clarification is needed.

Although #473's discussion covers many more topics, if we go back to the title and first question in the issue I think this resolves #473.

* Update specification/gedcom-3-structures-3-meaning.md

* Change recommendation

* Update specification/gedcom-3-structures-3-meaning.md

* Update specification/gedcom-3-structures-3-meaning.md

---------

Co-authored-by: Dave Thaler <[email protected]>

* Update extracted files (#501)

Co-authored-by: Luther Tychonievich <[email protected]>

* Restore 3.0's definition of jurisdiction (#506)

* Restore 3.0's definition of jurisdiction

Restored the definition of "jurisdiction" that was present in version 3.0.

Resolved #496

* Update specification/gedcom-3-structures-3-meaning.md

Additional examples and less proscriptive text

* Update extracted files (#508)

Co-authored-by: Luther Tychonievich <[email protected]>

* Increase largest PLAC example (#514)

* Increase largest PLAC example

resolves #512

* Update specification/gedcom-3-structures-3-meaning.md

* Update extracted files (#515)

Co-authored-by: Luther Tychonievich <[email protected]>

* Fix validate-yaml warnings (#513)

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>
Co-authored-by: Luther Tychonievich <[email protected]>

* Update changelog.md (#525)

* Update changelog.md

We've been making changes without updating the changelog. This summarizes the changes since v7.14 was released.

* Update changelog.md

* Update changelog.md

---------

Co-authored-by: Dave Thaler <[email protected]>

* EXID.TYPE for BillionGraves.com and WikiTree identifiers (#540)

* EXID.TYPE for BillionGraves.com and WikiTree identifiers

Fixes #539

* Update exid-types.json

Co-authored-by: Luther Tychonievich <[email protected]>

* Apply suggestions from code review

Co-authored-by: Luther Tychonievich <[email protected]>

---------

Co-authored-by: Dave Thaler <[email protected]>
Co-authored-by: Luther Tychonievich <[email protected]>

* v7.0.15 release (#537)

Co-authored-by: Dave Thaler <[email protected]>

* Update exid-types.json (#543)

* Update exid-types.json

Resolve incorrect URIs as noted in #539

* move /name

* move /name

* move /name

* move /name

* Clarify a deprecation (#547)

* Update extracted files (#542)

Co-authored-by: Dave Thaler <[email protected]>

* Fix documentation confusion about HEAD-SOUR-DATA (#553)

* Make HEAD.SOUR.DATA wording consistent between two places in spec

Signed-off-by: Dave Thaler <[email protected]>

* Deprecate HEAD.SOUR.DATA

Signed-off-by: Dave Thaler <[email protected]>

* Update specification/gedcom-3-structures-1-organization.md

* Update specification/gedcom-3-structures-3-meaning.md

* Update specification/gedcom-3-structures-3-meaning.md

---------

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Add note about blank payloads (#554)

* Add note about blank payloads

Based on discussion in issue #495

Signed-off-by: Dave Thaler <[email protected]>

* Update specification/gedcom-3-structures-1-organization.md

* Update specification/gedcom-3-structures-1-organization.md

* Update specification/gedcom-3-structures-1-organization.md

---------

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Always quote tags (#560)

* Update generate-files to use a PAT (#557)

* Fix names of workflows
* Make generate-files use a PAT so that validate-yaml will run

The PAT is already generated and configured in the repository secrets

Fixes #503

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

* Update extracted files (#555)

Co-authored-by: Dave Thaler <[email protected]>

* Don't warn about use of "on" as a YAML key (#562)

Per documentation at
https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.truthy

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>

---------

Signed-off-by: Dave Thaler <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Luther Tychonievich <[email protected]>
Co-authored-by: Luther Tychonievich <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>
Co-authored-by: Christopher Horn <[email protected]>
Co-authored-by: Dylan Stephano-Shachter <[email protected]>
Co-authored-by: elyoh <[email protected]>
Co-authored-by: Dave Thaler <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tychonievich tychonievich tychonievich approved these changes

@clarkegj clarkegj Awaiting requested review from clarkegj clarkegj is a code owner

@albertemmerich albertemmerich Awaiting requested review from albertemmerich albertemmerich is a code owner

@lynchrs3 lynchrs3 Awaiting requested review from lynchrs3 lynchrs3 is a code owner

@gibsongk gibsongk Awaiting requested review from gibsongk gibsongk is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation confusion about HEAD-SOUR-DATA
3 participants
@dthaler @tychonievich @dthaler2