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] PAGES: homepage.html broken issues url #84

Merged
merged 2 commits into from
Jun 27, 2022
Merged

[Fix] PAGES: homepage.html broken issues url #84

merged 2 commits into from
Jun 27, 2022

Conversation

sjokkateer
Copy link
Contributor

@sjokkateer sjokkateer commented May 22, 2022

Signed-off-by: Remy Bos [email protected]

Q A
Documentation yes
Bugfix yes
BC Break no
New Feature no
RFC no
QA no

Description

This PR attempts to fix an issue where the url to the issues page of the repository of a particular laminas component is broken.

Pages with a broken issues URL:

What I've done:

  • Manually check each laminas component and opened their documentation homepage.
  • Open every component's mkdocs.yml file in the repo and inspect the repo_url property for trailing slashes.

What I've discovered:

  • All sites that don't have the broken URL have a trailing slash at the URL for Source, one example: laminas-cache.
  • All sites that don't have the broken issue URL have no trailing slash in their mkdocs.yml file, one example: laminas-cache#L39

What I've concluded:
The components that don't have the broken URL are either cached or some caching is applied somewhere in the build process. Although the same error does not apply to the other component's homepage (yet) this will most likely apply at some point in the future.

Please let me know what you think of the 'investigation' and proposed change. And whether or not it is possible to freshly rebuild the documentations after the change takes effect?

@froschdesign
Copy link
Member

Please let me know what you think of the 'investigation' and proposed change.

Unfortunately, this does not help if a slash is already present. Therefore, the update script should ensure the correct URL.

And whether or not it is possible to freshly rebuild the documentations after the change takes effect?

Sure.

@froschdesign froschdesign added the Bug Something isn't working label May 22, 2022
@froschdesign
Copy link
Member

@froschdesign froschdesign merged commit e53c2d3 into laminas:master Jun 27, 2022
@froschdesign
Copy link
Member

@sjokkateer
Thank you for your time and this contribution! 👍

@froschdesign
Copy link
Member

@sjokkateer
Works perfectly: https://docs.laminas.dev/laminas-authentication/

@froschdesign
Copy link
Member

I will check now all documentations for the broken link.

@sjokkateer
Copy link
Contributor Author

@sjokkateer
Works perfectly: https://docs.laminas.dev/laminas-authentication/

@froschdesign Awesome, glad to hear that!

@sjokkateer
Copy link
Contributor Author

I will check now all documentations for the broken link.

@froschdesign, Were any of laminas-di, laminas-log, or laminas-diactoros rebuilt?

@froschdesign
Copy link
Member

froschdesign commented Jun 27, 2022

Broken links are included in:

Everything is good in Mezzio and laminas-mvc.

@sjokkateer
Copy link
Contributor Author

sjokkateer commented Jun 27, 2022

@froschdesign Barcode seems to be working for me, what is considered a broken url on that page?

@froschdesign
Copy link
Member

laminas-barcode is wrong on this list. Sorry and thanks for the hint!

@froschdesign
Copy link
Member

The problem in laminas-di will be fixed with the next release.
And there is also a release around the corner for laminas-diactoros.

But laminas-log is not in active development.

@sjokkateer
Copy link
Contributor Author

The problem in laminas-di will be fixed with the next release. And there is also a release around the corner for laminas-diactoros.

But laminas-log is not in active development.

Alright that would be nice :)!

@froschdesign
Copy link
Member

If you find other problems or have ideas for improvements, please let me know.
Thanks for your help! 👍

@sjokkateer
Copy link
Contributor Author

Any time, thank you too for your time!

@sjokkateer
Copy link
Contributor Author

Broken links are included in:

* [x]  https://docs.laminas.dev/laminas-code/

* [x]  https://docs.laminas.dev/laminas-dom/

* [x]  https://docs.laminas.dev/laminas-form/

* [ ]  https://docs.laminas.dev/laminas-log/ _(Action cannot be restarted via the GitHub website)_

* [x]  https://docs.laminas.dev/laminas-stdlib/

* [ ]  https://docs.laminas.dev/laminas-di/ _(Action cannot be restarted via the GitHub website)_

* [x]  https://docs.laminas.dev/laminas-servicemanager/

* [x]  https://docs.laminas.dev/laminas-inputfilter/

* [x]  https://docs.laminas.dev/laminas-validator/

* [x]  https://docs.laminas.dev/laminas-diactoros/ _(Action cannot be restarted via the GitHub website)_

Everything is good in Mezzio and laminas-mvc.

@froschdesign Awesome, it seems that after the release laminas-di's URLs are fixed too again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants