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

Editorial: Update ATK URL #2309

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Editorial: Update ATK URL #2309

wants to merge 3 commits into from

Conversation

smockle
Copy link
Contributor

@smockle smockle commented Aug 8, 2024

Initially filed as w3c/html-aam#560

https://gnome.pages.gitlab.gnome.org/atk/ (the URL currently referenced throughout html-aam) 404s, even after logging in to the GNOME GitLab instance1.

https://docs.gtk.org/atk/ (this PR’s replacement URL) seems to be the new location. GTK’s “API Docs” page links to this URL. Update: There are 3 candidates; details in #2309 (comment).

Preview: https://deploy-preview-2309--wai-aria.netlify.app/html-aam/

Test, Documentation and Implementation tracking Once this PR has been reviewed and has consensus from the working group, tests should be written and issues should be opened on browsers. Add N/A and check when not applicable.
  • "author MUST" tests:
  • "user agent MUST" tests:
  • Browser implementations (link to issue or commit):
    • WebKit:
    • Gecko:
    • Blink:
  • Does this need AT implementations?
  • Related APG Issue/PR:
  • MDN Issue/PR:

Footnotes

  1. That said, GNOME’s “Technologies” page still links to this URL. 🤷

Copy link

netlify bot commented Aug 8, 2024

Deploy Preview for wai-aria ready!

Name Link
🔨 Latest commit 4122754
🔍 Latest deploy log https://app.netlify.com/sites/wai-aria/deploys/66bfa6af2747fe00084478bb
😎 Deploy Preview https://deploy-preview-2309--wai-aria.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jnurthen jnurthen added the editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo label Aug 8, 2024
@scottaohara scottaohara self-requested a review August 15, 2024 16:10
@spectranaut spectranaut changed the title [html-aam] Update ATK URL Editorial: [html-aam] Update ATK URL Aug 15, 2024
@scottaohara
Copy link
Member

so.... initially i was thinking this would be good - replace all the links with the new link. but this doesn't actually fix the link in the referenced terms. that still goes to the old documentation page, and that's an issue in core aam and ARIA (all the specs i'd assume) as well.

but also, core aam doesn't link to each of the platform pages within each feature table.... and that got me wondering why this spec does/should continue to do so?

i'm thinking maybe the fix here is to fix the link in the informative references section, and instead change the atk links to use the reference link [[ATK]], as well as the platform references?

Copy link
Member

@scottaohara scottaohara left a comment

Choose a reason for hiding this comment

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

see prior comment

@smockle
Copy link
Contributor Author

smockle commented Aug 15, 2024

Thanks @scottaohara; that makes sense. 👍

I’ll update the PR to do what you’re suggesting:

…fix the link in the informative references section, and instead change the atk links to use the reference link [[ATK]], as well as the platform references…

One question: I found https://gnome.pages.gitlab.gnome.org/at-spi2-core/atk/ today; between that and https://docs.gtk.org/atk/, which should we use?

@smockle smockle marked this pull request as draft August 15, 2024 16:42
@scottaohara
Copy link
Member

@spectranaut do you know which we should be referring to, per @smockle's question above? seems the api version is the same in both, but the library version is different.

@smockle
Copy link
Contributor Author

smockle commented Aug 16, 2024

Quick updates:

@smockle smockle marked this pull request as ready for review August 16, 2024 19:44
@scottaohara
Copy link
Member

looks good to me. i am thinking we leave the link that's in the biblio.js already...

we can tackle changing the other platform api links to instead link to their reference section link in a follow on PR, if we dont' want to just do those here as well.

@spectranaut spectranaut changed the title Editorial: [html-aam] Update ATK URL Editorial: Update ATK URL Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo spec:html-aam
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants