training-manual icon indicating copy to clipboard operation
training-manual copied to clipboard

Fix hard-coded URLs

Open brianamarie opened this issue 4 years ago • 6 comments

(Thanks to @parkerbxyz for listing this in another issue! I'm moving to this new issue to be tracked separately)

As a part of open sourcing this repository, and renaming/moving it, one thing we’ll need to address is all of the hardcoded links to this repository that exist throughout its files:

My biggest concern is the teaching scripts. We’ll need to prepare a pull request with changes to the scripts that can be merged right after the rename to avoid disrupting any customer engagements. I think that goes for the remaining steps in the rename process; we’ll likely need to make the majority (if not all) of the changes in quick succession.

brianamarie avatar Jun 30 '20 09:06 brianamarie

@brianamarie what are your thoughts on using a custom (sub)domain for this repository? Instead of github.github.io/github-training-manual or github.github.com/github-training-manual, we could use the Professional Services subdomain so the URL would be services.github.com/github-training-manual. I think that would reduce redundancy in the URL (github.github.tld) and make the ownership of the site/repository more clear.

parkerbxyz avatar Jun 30 '20 23:06 parkerbxyz

@parkerbxyz I really like that idea.

Question about the "how": Is moving the URL to a subdomain something that we should include in this flow of change, or should we pursue it separately?

Everything at once

  • 👍 No double-phase of change that could lead to confusion
  • 👎 We would need to wait longer for open sourcing the repo, depending on how long the subdomain process takes

Separating into another workstream

  • 👍 We'd be able to open source the repo ASAP
  • 👎 We'd need another round of updates to the redirect (consequences of this may range from the inconvenience of a PR to confusing folks on where to find the repo)

@parkerbxyz @amyschoen what do you think?

brianamarie avatar Jul 01 '20 09:07 brianamarie

I’d personally like to do it all in one go if possible to avoid needing to handle multiple redirects.

parkerbxyz avatar Jul 01 '20 13:07 parkerbxyz

Sounds good to me, @parkerbxyz. Do you happen to know how we would begin to do this with http://github.com/github/services-site/?

brianamarie avatar Jul 01 '20 13:07 brianamarie

I agree. One go is better even if it makes this take a tad longer.

amyschoen avatar Jul 01 '20 13:07 amyschoen

I've posed the question in the services-site repo, and mentioned the folks who show commit history from the site team: https://github.com/github/services-site/issues/222

brianamarie avatar Jul 02 '20 08:07 brianamarie