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

docs: correct broken links reported #407

Closed
wants to merge 1 commit into from

Conversation

CyrilBaah
Copy link

Description

Update broken URLs in the project report by the automated bot

Motivation and context

To help users navigate through documentation easily with the updated URLs

If it fixes an open issue, please link to the issue here (if you write fixes #405
or closes #405 , the issue will be automatically closed when the pull is accepted.)

How has this been tested?

Please describe in detail how you tested your changes.

Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc.

  • Unit tests added / updated
  • The tests run on docker (using make test)
  • The required test data has been added / updated
  • The updated links

If you are running the tests locally, please specify:

  • OS: [e.g. ubuntu/macos/windows]
  • Go version [e.g. 1.19.x]

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • This change requires a documentation update

Checklist

Go over all the following points, and put an x in all the boxes that apply.

Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our continuous integration server to make sure your tests and code style pass.

  • I have read the CONTRIBUTING document.
  • My pull request addresses exactly one patch/feature.
  • I have created a branch for this patch/feature.
  • Each individual commit in the pull request is meaningful.
  • If my change requires a change to the documentation, I have updated it accordingly.

@github-actions github-actions bot added documentation Improvements or additions to documentation core meta-files labels Oct 2, 2024
Copy link
Owner

@VictorAvelar VictorAvelar left a comment

Choose a reason for hiding this comment

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

I've been reviewing the links you provided but I realise in the end it also requires changes in the code to introduce the new aliases and remove the no longer existing methods.

Do you think you can go ahead and make the code changes required for this PR? Otherwise Only update the first link to the signup and I'll take care of the code changes.

Thanks for giving it a go, let me know if you have any further questions.

Copy link
Owner

Choose a reason for hiding this comment

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

@CyrilBaah thanks for updating the links, however this documentation is generated automatically from the code, thus the links need to be updated in the code, otherwise the new links will be replaced as soon as another PR is merged to master and the docs are automatically regenerated.

@VictorAvelar
Copy link
Owner

Superseded by #408

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core documentation Improvements or additions to documentation meta-files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants