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

Rename ods to tods #78

Merged
merged 43 commits into from
Nov 19, 2024
Merged

Rename ods to tods #78

merged 43 commits into from
Nov 19, 2024

Conversation

isabelle-dr
Copy link
Contributor

ODS was renamed to TODS in June 2024.
This PR renames ODS to TODS so it appears everywhere on the website and there is no confusion.

Copy link

@isabelle-dr
Copy link
Contributor Author

@jfabi and @safrazier17 my apologies, I did this before seeing that there is #71 already open for it.

I modified more files here, including index.md which generates the landing page of the site, maybe we can use this one instead?
If you'd rather follow efforts in #71 I can also close this.

@safrazier17
Copy link
Contributor

@isabelle-dr this is great; happy to use this one and close #71

@isabelle-dr
Copy link
Contributor Author

Okay, could you give me the review here? :)

Copy link
Collaborator

@jfabi jfabi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not included in line, but I believe the mkdocs.yml file also needs to be updated, in order to edit the webpage footers:

Screen Shot 2024-08-17 at 16 06 57

docs/index.md Outdated Show resolved Hide resolved
docs/about/attribution.md Outdated Show resolved Hide resolved
docs/about/attribution.md Outdated Show resolved Hide resolved
docs/governance/actions.md Outdated Show resolved Hide resolved
docs/governance/policies/change-management-versioning.md Outdated Show resolved Hide resolved
docs/governance/governance.md Outdated Show resolved Hide resolved
docs/governance/governance.md Outdated Show resolved Hide resolved
docs/governance/governance.md Outdated Show resolved Hide resolved
docs/governance/governance.md Outdated Show resolved Hide resolved
docs/governance/governance.md Outdated Show resolved Hide resolved
Copy link
Contributor

@safrazier17 safrazier17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey Isabelle, made some requested additions, and added a few of the copy edits that i had on my previous PR into yours.

docs/about/about.md Outdated Show resolved Hide resolved
docs/about/attribution.md Outdated Show resolved Hide resolved
docs/about/attribution.md Outdated Show resolved Hide resolved
docs/about/contributors.md Outdated Show resolved Hide resolved
docs/about/spec-development.md Outdated Show resolved Hide resolved
docs/governance/governance.md Outdated Show resolved Hide resolved
docs/governance/governance.md Outdated Show resolved Hide resolved
docs/governance/policies/change-management-versioning.md Outdated Show resolved Hide resolved
docs/governance/policies/change-management-versioning.md Outdated Show resolved Hide resolved
@jfabi
Copy link
Collaborator

jfabi commented Sep 5, 2024

@isabelle-dr, would you be able to take another look at this branch when you next have a chance? Thanks!

@isabelle-dr
Copy link
Contributor Author

@safrazier17 and @jfabi, thank you for the review!

I made the fixes requested and updated mkdocs.yml. Please take another look :)

mkdocs.yml Outdated Show resolved Hide resolved
docs/about/about.md Show resolved Hide resolved
docs/resources/faq.md Outdated Show resolved Hide resolved
docs/governance/policies/change-management-versioning.md Outdated Show resolved Hide resolved
docs/governance/policies/change-management-versioning.md Outdated Show resolved Hide resolved
docs/governance/policies/change-management-versioning.md Outdated Show resolved Hide resolved
docs/governance/governance.md Outdated Show resolved Hide resolved
docs/governance/governance.md Outdated Show resolved Hide resolved
@isabelle-dr
Copy link
Contributor Author

@jfabi and @safrazier17 I made the changes requested, please take another look.

@safrazier17
Copy link
Contributor

Looks good to me @isabelle-dr, thank you

Copy link
Collaborator

@jfabi jfabi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small clarification to make, but otherwise this is looking very good, thank you!

docs/governance/actions.md Show resolved Hide resolved
Copy link
Collaborator

@jfabi jfabi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again, @isabelle-dr!

@isabelle-dr
Copy link
Contributor Author

@jfabi @safrazier17 it seems like I need a review from a maintainer, who would it be?
Also, do you know what is failing in the pre-commit.ci tests?

@safrazier17
Copy link
Contributor

@jfabi @safrazier17 it seems like I need a review from a maintainer, who would it be? Also, do you know what is failing in the pre-commit.ci tests?

@thekaveman I assume that you are one as a repo owner, can you take a look?

Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jfabi @safrazier17 it seems like I need a review from a maintainer, who would it be? Also, do you know what is failing in the pre-commit.ci tests?

@thekaveman I assume that you are one as a repo owner, can you take a look?

The pre-commit checks are failing for a number of Markdown formatting issues. Nothing looks to be critical, so I leave it to you all if you want to address these or just go with it as-is. I will note that if these aren't fixed at some point, the warnings will continue.

Output:

docs/governance/governance.md:37:3 MD051/link-fragments Link fragments should be valid [Context: "[TODS Specification](#operational-data-standard-tods-specification)"]
docs/governance/governance.md:70:20 MD051/link-fragments Link fragments should be valid [Context: "[TODS Specification](#operational-data-standard-tods-specification)"]
docs/governance/governance.md:74:66 MD051/link-fragments Link fragments should be valid [Context: "[TODS Specification](#operational-data-standard-TODS-specification)"]
docs/governance/governance.md:78:47 MD051/link-fragments Link fragments should be valid [Context: "[TODS Specification](#operational-data-standard-tods-specification)"]
docs/governance/governance.md:95:5 MD051/link-fragments Link fragments should be valid [Context: "[TODS Specification](#operational-data-standard-tods-specification)"]
docs/governance/governance.md:112:60 MD051/link-fragments Link fragments should be valid [Expected: #tods-board-of-directors; Actual: #TODS-board-of-directors] [Context: "[TODS Board of Directors](#TODS-board-of-directors)"]
docs/governance/governance.md:118:143 MD051/link-fragments Link fragments should be valid [Context: "[TODS Specification](#operational-data-standard-tods-specification)"]
docs/governance/governance.md:119:98 MD051/link-fragments Link fragments should be valid [Expected: #tods-manager; Actual: #TODS-manager] [Context: "[TODS Manager](#TODS-manager)"]
docs/governance/governance.md:121:96 MD051/link-fragments Link fragments should be valid [Expected: #tods-board-of-directors; Actual: #TODS-board-of-directors] [Context: "[TODS Board](#TODS-board-of-directors)"]
docs/governance/policies/change-management-versioning.md:202:1 MD053/link-image-reference-definitions Link and image reference definitions should be needed [Unused link or image reference definition: "tods-spec"] [Context: "[tods-spec]: ../governance.md#..."]
docs/index.md:73 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
docs/index.md:78 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
docs/spec/examples.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "f# Examples"]
docs/spec/revision-history.md:6 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* Removes files `deadheads.txt..."]
docs/spec/revision-history.md:8:1 MD007/ul-indent Unordered list indentation [Expected: 4; Actual: 3]

@safrazier17
Copy link
Contributor

@jfabi @safrazier17 it seems like I need a review from a maintainer, who would it be? Also, do you know what is failing in the pre-commit.ci tests?

@thekaveman I assume that you are one as a repo owner, can you take a look?

The pre-commit checks are failing for a number of Markdown formatting issues. Nothing looks to be critical, so I leave it to you all if you want to address these or just go with it as-is. I will note that if these aren't fixed at some point, the warnings will continue.

Output:

docs/governance/governance.md:37:3 MD051/link-fragments Link fragments should be valid [Context: "[TODS Specification](#operational-data-standard-tods-specification)"]
docs/governance/governance.md:70:20 MD051/link-fragments Link fragments should be valid [Context: "[TODS Specification](#operational-data-standard-tods-specification)"]
docs/governance/governance.md:74:66 MD051/link-fragments Link fragments should be valid [Context: "[TODS Specification](#operational-data-standard-TODS-specification)"]
docs/governance/governance.md:78:47 MD051/link-fragments Link fragments should be valid [Context: "[TODS Specification](#operational-data-standard-tods-specification)"]
docs/governance/governance.md:95:5 MD051/link-fragments Link fragments should be valid [Context: "[TODS Specification](#operational-data-standard-tods-specification)"]
docs/governance/governance.md:112:60 MD051/link-fragments Link fragments should be valid [Expected: #tods-board-of-directors; Actual: #TODS-board-of-directors] [Context: "[TODS Board of Directors](#TODS-board-of-directors)"]
docs/governance/governance.md:118:143 MD051/link-fragments Link fragments should be valid [Context: "[TODS Specification](#operational-data-standard-tods-specification)"]
docs/governance/governance.md:119:98 MD051/link-fragments Link fragments should be valid [Expected: #tods-manager; Actual: #TODS-manager] [Context: "[TODS Manager](#TODS-manager)"]
docs/governance/governance.md:121:96 MD051/link-fragments Link fragments should be valid [Expected: #tods-board-of-directors; Actual: #TODS-board-of-directors] [Context: "[TODS Board](#TODS-board-of-directors)"]
docs/governance/policies/change-management-versioning.md:202:1 MD053/link-image-reference-definitions Link and image reference definitions should be needed [Unused link or image reference definition: "tods-spec"] [Context: "[tods-spec]: ../governance.md#..."]
docs/index.md:73 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
docs/index.md:78 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
docs/spec/examples.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "f# Examples"]
docs/spec/revision-history.md:6 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* Removes files `deadheads.txt..."]
docs/spec/revision-history.md:8:1 MD007/ul-indent Unordered list indentation [Expected: 4; Actual: 3]

Thanks @thekaveman. I will merge for now and make a note to fix the MD when I get back from leave

@safrazier17 safrazier17 merged commit d1d0ee8 into cal-itp:main Nov 19, 2024
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants