Repository navigation
fix: use Ruby 3.4 for website builds, update documentation - #1544
GitToTheHub wants to merge 4 commits into
Conversation
|
Re: cdd54ac Capitalization every word under a title isn't really proper in the US English I believe. Minor words (a, the, and, etc) aren't suppose to be capitalized, unless if they are the first or last word of the title, e.g: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case for general rules for title capitalization. |
I cannot remember correctly but when I saw one time changes on a markdown here on Cordova, the words on a title were changed to be started all uppercased. But I don't know if this was only for nouns or for every word. So is this the right approach for markdown titles, what you wrote? |
Yah that's not really correct... minor words are not capitalized. General rules for title capitalization:
Minor words are:
Major words are all nouns, verbs, adjectives, pronouns, adverbs. If the word is four letters or more, it's going to be a major word basically and should be capitalized. None of the above is an exhaustive list, just examples. The APA style guide is a good source, is what most editorial uses and is probably what we should follow for our documentation, and afaik most of our document already does follow the APA style. |
|
Wow Norman, thanks for this very detailed overview of it. It's like a rule book. I will change the titles accordingly. Should we document this somewhere in the Cordova project? |
Not sure if that is really necessary... APA writing style is pretty standard practice. |
|
Ok, I never heard about APA. |
|
I created PR #1545 which adds this to https://github.com/apache/cordova-docs/blob/master/doc/docs-STYLEGUIDE.md#structure-and-flow and add a check to the pull request template. |
|
Is this PR here good to go? |
6ee1506 to
8976cd9
Compare
Generated-by: OpenAI Codex (GPT-6.1 Sol)
Generated-by: OpenAI Codex (GPT-6.1 Sol)
Generated-by: OpenAI Codex (GPT-6.1 Sol)
Generated-by: OpenAI Codex (GPT-6.1 Sol)
8976cd9 to
818fc78
Compare
Platforms affected
Website build and deployment workflows (GitHub Actions).
Motivation and Context
The staging deployment fails during Ruby setup because
ubuntu-latestnow resolves to Ubuntu 26.04 and Ruby 2.7.8 has no binary for that runner.Description
Testing
Validated locally on macOS with an isolated Ruby 3.4.9 runtime:
npm ciandnpm testpass (Node.js 22.17.1).npm run buildandnpm run build:prodpass using the freshly resolved gems and Jekyll 4.4.1. Existing Sass deprecation warnings remain.git diff --checkpass.The Ubuntu runner environment has not been exercised locally; GitHub Actions will provide that verification.
Checklist
(platform)if this change only applies to one platform (not applicable)Generative Tooling Disclosure
OpenAI Codex generated the workflow edits, documentation and README/badge changes, and heading corrections in this PR. It also ran the commands reported under Testing. The runtime change was based on the linked failed job and Ruby binary availability; setup instructions were checked against the Homebrew and RubyInstaller documentation.
All commits carry
Generated-by: OpenAI Codex (GPT-6.1 Sol)in accordance with the provenance recommendation in the ASF Generative Tooling Guidance. The model used was GPT-6.1 Sol, as confirmed by the contributor; the exact Codex application build was not recorded. The PR description was also drafted using Codex.Automated validation does not establish human review or certify licensing compliance. The contributor and reviewers remain responsible for evaluating the changes, applicable tool terms, and any third-party material before acceptance under the ASF guidance. This disclosure does not assert that a human review or training-data similarity scan has been completed.