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

Fix broken document links #378

Merged
merged 6 commits into from
Mar 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The build script (`bin/build.sh`) works in the following steps:

1. Remove old `build` folder if it exists and create a new one.
2. Copy the `documents` folder into `build` (all changes are applied inside of the `build` folder).
3. Replace all occurences of `wca{[url]}` with the actual URL to the website (used as a shortcut).
3. Replace all occurences of `wca{[url]}` and `wcadoc{[url]}` with the actual URL to the website (used as a shortcut).
4. Replace all occurences of `{logo}` with the actual absolute path to the WCA logo in `assets/WCAlogo_notext.svg` (used as a shortcut).
5. Convert all Markdown files to HTML, while applying the styling in `assets/style.css`. HTML files are created and put next to each corresponding Markdown file.
6. Convert all temporary HTML files in `documents` to PDF. PDF files are created and put next to each corresponding Markdown file.
Expand Down
4 changes: 3 additions & 1 deletion bin/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ set -x

# WCA url and absolute path to WCA logo file
wca_url="https://worldcubeassociation.org/"
wca_docs_url="https://documents.worldcubeassociation.org/"
logo=$(realpath "./assets/WCAlogo_notext.svg")
# Absolute paths to the stylesheets and the edudoc header
stylesheet=$(realpath "./assets/style.css")
Expand All @@ -28,8 +29,9 @@ convert_to_pdf() {
file_headline=$(head -n 1 "$file")
document_title=$(echo "$file_headline" | sed -E "s/#+\s*//")

# Replace wca{...} with absolute WCA URLs (the correct URLs only get inserted in production)
# Replace wca{...} and wcadoc{...} with absolute WCA URLs (the correct URLs only get inserted in production)
sed -Ei "s#wca\{([^}]*)\}#$wca_url\1#g" "$file"
sed -Ei "s#wcadoc\{([^}]*)\}#$wca_docs_url\1#g" "$file"
# Replace {logo} with the path to the WCA logo in /assets
sed -Ei "s#\{logo\}#$logo#g" "$file"

Expand Down
4 changes: 3 additions & 1 deletion documents-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ We also have a couple custom shortcuts in our repo:
![WCA Logo]({logo})
```

wca{...} - inserts URL to a page on the WCA website. Example: wca{regulations/guidelines} gets converted to https://www.worldcubeassociation.org/regulations/guidelines/. This shortcut is not necessary to use, but it can make your Markdown look cleaner.
wca{...} - inserts URL to a page on the WCA website. Example: `wca{regulations/guidelines}` gets converted to `https://www.worldcubeassociation.org/regulations/guidelines/`.

wcadoc{...} - inserts URL to a document page on the WCA website (any page with `documents.` as the subdomain). Example: `wcadoc{documents/policies/external/Competition Requirements.pdf}` gets converted to `https://documents.worldcubeassociation.org/documents/policies/external/Competition Requirements.pdf`.

### Commonly-used elements

Expand Down
2 changes: 1 addition & 1 deletion documents/Code of Ethics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The Code of Ethics must be considered by all Staff members of the World Cube Association (WCA), referred to in this document as “WCA Staff”, as a standard for actions and decisions they will be making when acting on behalf of the WCA within their role. “Listed Delegates” refers to WCA Delegates who are publicly displayed on the “General info” tab of an official WCA Competition.

These actions and decisions should be made in such a manner that, if consistently performed by WCA Staff, the [Spirit and Mission](wca{documents/motions/01.2019.1 - Spirit.pdf}) of the WCA would continue to be upheld while not breaking any [Regulations](wca{regulations}), [Motions, or Policies](wca{documents}).
These actions and decisions should be made in such a manner that, if consistently performed by WCA Staff, the [Spirit and Mission](wcadoc{documents/motions/01.2021.1 - Spirit.pdf}) of the WCA would continue to be upheld while not breaking any [Regulations](wca{regulations}), [Motions, or Policies](wca{documents}).

This Code covers previously known issues, as well as issues that the WCA Ethics Committee (WEC) foresees as requiring additional guidance. This document will be updated periodically to incorporate new topics as they are brought to the attention of the WEC, and will also be reviewed regularly.

Expand Down
2 changes: 1 addition & 1 deletion documents/motions/01.2021.1 - Spirit.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
1. The World Cube Association (WCA) is the world governing body for the sport of Speedcubing.
2. The Mission of the World Cube Association is to have more competitions in more countries with more people and more fun, under fair and equal conditions.
3. The Spirit of the World Cube Association is that people from all over the world have fun together in a friendly atmosphere, help each other, and behave in a sportsmanlike fashion.
4. The World Cube Association exists for its Registered Speedcubers and thus the key value of WCA Staff is to serve the Registered Speedcubers of the WCA. See [WCA Motion : Registered Speedcubers](wca{documents/motions/07.2021.1 - Registered Speedcubers.pdf}).
4. The World Cube Association exists for its Registered Speedcubers and thus the key value of WCA Staff is to serve the Registered Speedcubers of the WCA. See [WCA Motion : Registered Speedcubers](wcadoc{documents/motions/07.2021.1 - Registered Speedcubers.pdf}).
18 changes: 9 additions & 9 deletions documents/motions/04.2022.1 - WCA Board.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,21 @@
The WCA Board of Directors is the leadership team of the WCA and its highest authority.

1. The WCA Board has the following duties:
1. To guide, serve, and unite the WCA Community in accordance with the [WCA Motion : Objectives](wca{documents/motions/03.2021.1 - Objectives.pdf}).
2. To oversee, guide, and supervise all Staff of the WCA in accordance with the [WCA Motion : Objectives](wca{documents/motions/03.2021.1 - Objectives.pdf}).
3. To oversee, guide, and supervise all structural and day-to-day activities of the WCA in accordance with the [WCA Motion : Objectives](wca{documents/motions/03.2021.1 - Objectives.pdf}).
1. To guide, serve, and unite the WCA Community in accordance with the [WCA Motion : Objectives](wcadoc{documents/motions/03.2021.1 - Objectives.pdf}).
2. To oversee, guide, and supervise all Staff of the WCA in accordance with the [WCA Motion : Objectives](wcadoc{documents/motions/03.2021.1 - Objectives.pdf}).
3. To oversee, guide, and supervise all structural and day-to-day activities of the WCA in accordance with the [WCA Motion : Objectives](wcadoc{documents/motions/03.2021.1 - Objectives.pdf}).
4. To oversee, guide, and supervise all relationships with Regional Organizations and Sponsors.
5. To mobilize Staff, Regional Organizations, and Competition Organizers to organize WCA Competitions on local, national, continental, and world level, well distributed in time and geographical location, and to ensure the quality of WCA Competitions up to the maximum extent.
6. To represent the WCA in all dealings with other relevant organizations and with media.
7. To negotiate or oversee the negotiation of all contracts on behalf of the WCA in consultation with the appropriate Committees.
2. The WCA Board has the following rights:
1. To amend the Bylaws and their Motions. Such rights must be exercised in accordance with [WCA Motion : Amendments of Bylaws and Motions](wca{documents/motions/13.2022.1 - Amendments of Motions.pdf}).
2. To approve amendments to the Regulations. Such rights must be exercised in accordance with [WCA Motion : Amendments of Regulations](wca{documents/motions/14.2022.1 - Amendments of Regulations.pdf}).
1. To amend the Bylaws and their Motions. Such rights must be exercised in accordance with [WCA Motion : Amendments of Bylaws and Motions](wcadoc{documents/motions/13.2022.1 - Amendments of Motions.pdf}).
2. To approve amendments to the Regulations. Such rights must be exercised in accordance with [WCA Motion : Amendments of Regulations](wcadoc{documents/motions/14.2022.1 - Amendments of Regulations.pdf}).
3. To establish and remove Committees or change their duties. Such rights must be exercised in accordance with the Motion relative to every Committee.
4. To instate and remove Senior Delegates. Such rights must be exercised in accordance with [WCA Motion : Senior Delegates](wca{documents/motions/09.2022.1 - Senior Delegates.pdf}).
5. To instate and remove Regional Delegates. Such rights must be exercised in accordance with [WCA Motion : Regional Delegates](wca{documents/motions/09.2021.2 - Regional Delegates.pdf}).
6. To suspend or take other sanctions against Registered Speedcubers and to reinstate Registered Speedcubers that have been suspended. Such rights must be exercised in accordance with [WCA Motion : Suspensions and other Sanctions](wca{documents/motions/15.2022.1 - Suspensions and other Sanctions.pdf}).
7. To approve the annual budget proposal of the WCA Financial Committee in accordance with [WCA Motion : Finances](wca{documents/motions/11.2023.1 - Finances.pdf}).
4. To instate and remove Senior Delegates. Such rights must be exercised in accordance with [WCA Motion : Senior Delegates](wcadoc{documents/motions/09.2022.1 - Senior Delegates.pdf}).
5. To instate and remove Regional Delegates. Such rights must be exercised in accordance with [WCA Motion : Regional Delegates](wcadoc{documents/motions/09.2021.2 - Regional Delegates.pdf}).
6. To suspend or take other sanctions against Registered Speedcubers and to reinstate Registered Speedcubers that have been suspended. Such rights must be exercised in accordance with [WCA Motion : Suspensions and other Sanctions](wcadoc{documents/motions/15.2022.1 - Suspensions and other Sanctions.pdf}).
7. To approve the annual budget proposal of the WCA Financial Committee in accordance with [WCA Motion : Finances](wcadoc{documents/motions/11.2023.1 - Finances.pdf}).
8. To accept or not accept results of WCA Competitions as official, according to the procedures in the Regulations.
9. To overrule any decision under control of the WCA, as long as the overruling complies with the WCA Bylaws, their Motions, and the Regulations.
3. Decisions of the WCA Board are based on majority voting in the WCA Board.
Expand Down
2 changes: 1 addition & 1 deletion documents/motions/07.2021.1 - Registered Speedcubers.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Persons who are Registered Speedcubers have the role of Non-voting Member of the
4. Statuses of Registered Speedcubers <br> All Registered Speedcubers have one or more of the following statuses of Registration:
1. Active. Any Registered Speedcuber who has competed in any WCA Competition in the last 24 months.
2. Passive. Any Registered Speedcuber who is not considered an active Registered Speedcuber.
3. Suspended. Any Registered Speedcuber who is not eligible as a competitor in any WCA Competition for a defined period because of a disciplinary ruling by the WCA in accordance with [WCA Motion : Suspensions and other Sanctions](wca{documents/motions/15.2022.1 - Suspensions and other Sanctions.pdf}).
3. Suspended. Any Registered Speedcuber who is not eligible as a competitor in any WCA Competition for a defined period because of a disciplinary ruling by the WCA in accordance with [WCA Motion : Suspensions and other Sanctions](wcadoc{documents/motions/15.2022.1 - Suspensions and other Sanctions.pdf}).
5. Rights of Registered Speedcubers
1. The rights of Registered Speedcubers regarding their Registration in the WCA are defined by the role of Non-voting Member in the Bylaws and in the Motions.
2. The rights of Registered Speedcubers in WCA Competitions are defined by the role of Competitor in the WCA Regulations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The WCA Competition Announcement Team is an Advisory Committee of the WCA.
2. The WCA Competition Announcement Team has the following rights and duties:
1. Announcing WCA Competitions:
1. Approving and announcing WCA Competitions.
1. Ensuring announcements adhere to the [WCA Competition Requirements Policy](wca{documents/policies/external/Competition Requirements.pdf}).
1. Ensuring announcements adhere to the [WCA Competition Requirements Policy](wcadoc{documents/policies/external/Competition Requirements.pdf}).
2. Rejecting competitions.
2. Editing WCA Competitions:
1. Editing WCA Competitions data and metadata after they have been announced, at the request of the WCA Delegate(s), the WCA Competition Announcement Team, or the WCA Board.
Expand Down
2 changes: 1 addition & 1 deletion documents/motions/10.2021.6 - Financial Committee.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@
4. Reporting and advising on a quarterly basis to the WCA Board on the finances of the WCA.
5. Reporting on a periodic basis to external organizations on the finances of the WCA, based on all applicable legal requirements.
6. Appointing and supporting financial auditors based on all applicable legal requirements.
7. Collecting Dues from WCA competitions as per the [WCA Dues System Policy](wca{documents/policies/external/Dues System.pdf})
7. Collecting Dues from WCA competitions as per the [WCA Dues System Policy](wcadoc{documents/policies/external/Dues System.pdf})
2. The Leader of the WCA Financial Committee is the Treasurer of the WCA.
2 changes: 1 addition & 1 deletion documents/motions/10.2021.9 - Regulations Committee.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The WCA Regulations Committee is an Advisory Committee of the WCA with the follo

1. Managing the maintenance of the Regulations of the WCA, containing all regulations that must be followed in and around WCA Competitions.
1. The Regulations should contain all clear, concise, normative rules as a proper standard for WCA Competitions.
2. Producing and publishing new versions of the Regulations on a periodic basis, based on feedback from WCA Staff and Registered Speedcubers, their own insights, and incidents that happened during WCA Competitions. Such rights must be exercised in accordance with [WCA Motion : Amendments of Regulations](wca{documents/motions/14.2022.1 - Amendments of Regulations.pdf}).
2. Producing and publishing new versions of the Regulations on a periodic basis, based on feedback from WCA Staff and Registered Speedcubers, their own insights, and incidents that happened during WCA Competitions. Such rights must be exercised in accordance with [WCA Motion : Amendments of Regulations](wcadoc{documents/motions/14.2022.1 - Amendments of Regulations.pdf}).
3. Delivering interim updates of the Regulations in case of urgent changes or clerical errors.
4. Resolving issues with the Regulations, based on feedback from the Community and from reports of WCA Competitions.
5. Decision making on incidents that happened during WCA Competitions, based on feedback from the Community, WCA Staff, Registered Speedcubers, or reports of WCA Competitions.
Expand Down
2 changes: 1 addition & 1 deletion documents/motions/10.2022.3 - Disciplinary Committee.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The WCA Disciplinary Committee is an Advisory Committee of the WCA.
1. The subjects of the investigations are incidents during WCA Competitions, incidents related to WCA Competitions, or incidents within the WCA Community. Incidents are alleged violations of the Spirit and/or Regulations of the WCA.
2. Delivering an independent report on the investigations.
3. Involving the WCA Ethics Committee in case any WCA Staff Member is suspected of acts against the Spirit of the WCA or not compliant with the Code of Ethics.
4. Making decisions on disciplinary actions in relation to the investigated incidents. See [WCA Motion : Suspensions and other Sanctions](wca{documents/motions/15.2020.1 - Suspensions and other Sanctions.pdf}).
4. Making decisions on disciplinary actions in relation to the investigated incidents. See [WCA Motion : Suspensions and other Sanctions](wcadoc{documents/motions/15.2022.1 - Suspensions and other Sanctions.pdf}).
2. Confidant
1. Being the confidential contact for Registered Speedcubers and WCA Staff, in case of important personal matters that are related to WCA activities.
3. Information and administration
Expand Down
6 changes: 3 additions & 3 deletions documents/motions/19.2021.1 - Regulations and Guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

1. All the WCA Competitions are conducted and ruled according to the WCA Regulations.
2. The WCA Regulations are enhanced and clarified by the WCA Guidelines.
3. The maintenance and update of the Regulations and Guidelines is a duty of the WCA Regulations Committee. See [WCA Motion : WCA Regulations Committee](wca{documents/motions/10.2021.9 - Regulations Committee.pdf}) for further information.
4. Amendments to Regulations and Guidelines are done by the WCA Regulations Committee according to [WCA Motion : Amendments of Regulations](wca{documents/motions/14.2022.1 - Amendments of Regulations.pdf}).
5. A copy of the in force WCA Regulations and Guidelines is always available online in American English through [https://www.worldcubeassociation.org/regulations/](https://www.worldcubeassociation.org/regulations/)
3. The maintenance and update of the Regulations and Guidelines is a duty of the WCA Regulations Committee. See [WCA Motion : WCA Regulations Committee](wcadoc{documents/motions/10.2021.9 - Regulations Committee.pdf}) for further information.
4. Amendments to Regulations and Guidelines are done by the WCA Regulations Committee according to [WCA Motion : Amendments of Regulations](wcadoc{documents/motions/14.2022.1 - Amendments of Regulations.pdf}).
5. A copy of the in force WCA Regulations and Guidelines is always available online in American English through [wca{regulations}](wca{regulations})
6. Translations of the WCA Regulations and Guidelines are offered by the WCA for convenience. If there is a difference between a translation and the American English version, the American English version prevails.
Loading