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

Update links from Delegate Crash Course to Delegate Handbook #9308

Merged
merged 2 commits into from
Jun 25, 2024

Conversation

nsilvestri
Copy link
Contributor

The Delegate Crash Course has been deprecated in favor of the Delegate Handbook. This PR updates existing references to the DCC to the Handbook where it is still relevant, or removes references to the DCC entirely where they are no longer needed.

@danieljames-dj
Copy link
Member

Hi @nsilvestri, may I know by when are you planning to get this PR merged? Does WQAC has any deadline for the same?

The reason why I'm asking is, in /panel, Delegate Panel is going to be migrated to a separate react component. I've already raised the PR to migrate Delegate Panel: #9332. Once that is merged, you should be able to update delegate-crash-course to delegate-handbook more easily probably.

@nsilvestri
Copy link
Contributor Author

nsilvestri commented May 2, 2024

@danieljames-dj this PR will be pending the Delegate Handbook being added to wca-documents, hopefully 2ish weeks? Don't let this PR be a blocker for making any changes to the panel, I can adapt to whatever changes happen in the meantime.

config/routes.rb Outdated Show resolved Hide resolved
@nsilvestri nsilvestri changed the title Update links to Delegate Handbook in panel views and EditPerson component Update links from Delegate Crash Course to Delegate Handbook Jun 23, 2024
@nsilvestri nsilvestri marked this pull request as ready for review June 23, 2024 20:42
Copy link
Member

@danieljames-dj danieljames-dj left a comment

Choose a reason for hiding this comment

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

The code looks good to me. I've raised a comment at the place where I have a slight concern but not sure if it's solvable. I would like @gregorbg to have a look to give the final approval.

Thanks @nsilvestri for working on this. 🎉

<%= link_to "'Submitting competition results' section of the delegate crash course",
panel_delegate_crash_course_path %>.
<%= link_to "'Competition Results' section of the Delegate Handbook",
"https://documents.worldcubeassociation.org/edudoc/delegate-handbook/delegate-handbook.pdf#competition-results" %>.
Copy link
Member

Choose a reason for hiding this comment

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

  1. I tried opening this link, but it's not scrolling to the section in the handbook. Is this something that is supported in at least some browsers?
  2. Having the same URL hardcoded in two places looks bit odd, but I cannot think of a way to solve it especially because there is a hash parameter. Just mentioning here so that you or somebody else will be able to find a solution.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  1. Yes; on Firefox the link takes me straight to the section. It should be supported in other browses as AFAIK it's the same as heading tag hashes in URLs, but if it doesn't work in some browser configuration that's nbd to me since otherwise the link works and the section is explicitly called out here.
  2. I'm not sure how you'd prefer to handle a constant like this across Rails code and React code, open to suggestions if it's a priority fix. Changing this around would also be easy in a subsequent commit if required.

@danieljames-dj
Copy link
Member

I'm approving this for now, if any solution for the URL comes up, we can take it up later.

@danieljames-dj danieljames-dj merged commit 1e83c26 into thewca:main Jun 25, 2024
1 check passed
@nsilvestri nsilvestri deleted the delegate-handbook-panel branch June 25, 2024 01:59
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.

None yet

2 participants