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 documentation links in code #815

Merged
merged 1 commit into from
Mar 9, 2022
Merged

Conversation

carterworks
Copy link
Contributor

Description

I fixed 3 broken documentation links.

Related Issue

#808 first made us aware of the issue.

#813 fixes the issue in the README, this fixes a few of the issues throughout the code, in error messages and comments.

Motivation and Context

https://developer.adobe.com/apis/experience-platform was deprecated, which all our short links pointed to. The new home for Alloy user documentation is now at https://experienceleague.adobe.com/docs/experience-platform/edge/

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (non-breaking change which does not add functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA or I'm an Adobe employee.
  • I have made any necessary test changes and all tests pass.
  • I have run the Sandbox successfully.

@carterworks
Copy link
Contributor Author

carterworks commented Feb 14, 2022

It looks like the unit tests failed because of a SauceLabs thing (maybe rate limiting?), not because of any actual test failures. The tests have succeeded after a test re-run.

Copy link
Contributor

@jonsnyder jonsnyder left a comment

Choose a reason for hiding this comment

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

The idea with the bitly links is that we can update the URLs without having to change the code. This is so that people with old versions of the SDK can follow these links and be redirected to the correct URL. We should update the bitly links to point to the correct place. Then a code change isn't necessary. We should do this with #813 as well. Maybe we could add some documentation to the GIT wiki on how to do this.

@carterworks
Copy link
Contributor Author

I've talked with Martin, and I don't think we can just update the target of the shortlinks like that without changing the hash. To point to a new location, I'm 85% sure we need to change the link itself.

Copy link
Contributor

@jonsnyder jonsnyder left a comment

Choose a reason for hiding this comment

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

If we don't hear back from corporate on possibly redirecting the old links, I'm fine with changing these.

@jfkhoury
Copy link
Contributor

jfkhoury commented Mar 2, 2022

@liljenback I thought there's a tool somewhere that allows updating those URL without changing them, is that not the case?

@jonsnyder jonsnyder merged commit 26f128c into main Mar 9, 2022
@jonsnyder jonsnyder deleted the fix-doc-links-in-code branch March 9, 2022 17:49
@github-actions github-actions bot mentioned this pull request Mar 9, 2022
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.

4 participants