Fix links #2614

adriendupuis · 2025-02-14T09:03:18Z

Question	Answer
JIRA Ticket	N/A
Versions	master, 4.6
Edition	All

Fix broken links.
Fix missing anchors.
Follow redirections.

Checklist

Text renders correctly
Text has been checked with vale
Description metadata is up to date
Redirects cover removed/moved pages
Code samples are working
PHP code samples have been fixed with PHP CS fixer
Added link to this PR in relevant JIRA ticket or code PR

github-actions · 2025-02-14T09:07:13Z

Preview of modified Markdown:

"This document has been superseded."

Browser add-ons links are dead. Not really safe to recommend tools we don't monitor.

…ation

Section renamed in #2422 with content not changed.

…ion/reference

…mentation/reference

It often changes without any consistency https://web.archive.org/web/*/https://www.php.net/manual/en/install.fpm.configuration.php

formatting_date_and_time.md: section was renamed in #2506

docs/multisite/siteaccess/siteaccess_matching.md

adriendupuis · 2025-02-17T09:27:39Z

mkdocs.yml

@@ -936,7 +936,7 @@ extra:
  latest_tag_4_5: '4.5.7'
  latest_tag_4_6: '4.6.16'

-  symfony_doc: 'https://symfony.com/doc/5.4'
+  symfony_doc: 'https://symfony.com/doc/5.x'
  user_doc: 'https://doc.ibexa.co/projects/userguide/en/master'


Side note: since master is hidden, maybe we should make this change:

Suggested change

user_doc: 'https://doc.ibexa.co/projects/userguide/en/master'

user_doc: 'https://doc.ibexa.co/projects/userguide/en/latest'

Definitely, nice catch!

Or maybe it should be set per branch?
user_doc: 'https://doc.ibexa.co/projects/userguide/en/4.6' for 4.6
user_doc: 'https://doc.ibexa.co/projects/userguide/en/3.3' for 3.3

This way the links are compatible between versions

We could... but then we'd have to change all links when bumping version and remember about changing them when cherrypicking changes to older branches

We wouldn't have to do this - we could just use the variable, as we currently do.

The value of the variable would change between branches, but the syntax wouldn't.

This example:

[I'm a link]([[= user_doc =]]/personalization/personalization/)

would link to:

https://doc.ibexa.co/projects/userguide/en/3.3/personalization/personalization/ on 3.3 branch of the dev doc

https://doc.ibexa.co/projects/userguide/en/4.6/personalization/personalization/ on 4.6 branch of the dev doc

So, no changing links when creating the 5.0 branch (and no changes when cherry-picking), we would only make one single change in mkdocs.yaml when creating the 5.0 branch - and the links would become "version-aware"

I'm suggesting we do the same thing we already do for the Symfony doc:

https://github.com/ibexa/documentation-developer/blob/2.5/mkdocs.yml#L411

https://github.com/ibexa/documentation-developer/blob/4.6/mkdocs.yml#L938

which is not causing any issues currently

Fix links 4.6 #2618

Fix links 3.3 #2619

@mnocon @dabrt I propose to not make decision about this in this PR. Let dev's master targets user's master for now. I'll test and we'll discuss latter what 4.6 targeting 4.6 and 3.3 targeting 3.3 imply.

docs/commerce/payment/enable_paypal_payments.md

docs/commerce/transactional_emails/transactional_emails.md

docs/search/search_engines/solr_search_engine/install_solr.md

Co-authored-by: Marek Nocoń <[email protected]>

mnocon

Thank you!

… =]]

# Conflicts: # docs/content_management/images/fastly_io.md

(cherry picked from commit 826c6f7)

adriendupuis added 2 commits February 14, 2025 09:50

ibexa_dxp_v3.2.md: Fix link to REST JWT

450f620

graphql_operations.md: Fix link to mutation doc

53685e8

adriendupuis added 26 commits February 14, 2025 10:11

mkdocs.yml: symfony.com/doc/5.4 → 5.x

7089be6

php_api.md: [[= symfony_doc =]] syntax

e0b8ec2

rest_requests.md: Update Allow header doc

c599670

"This document has been superseded."

testing_rest_api.md: remove tool reco

16597b3

Browser add-ons links are dead. Not really safe to recommend tools we don't monitor.

reorder.md: Fix "Merge carts" link

2626781

enable_paypal_payments.md: update link

0bed70e

payum_integration.md: update link

e4796a5

transactional_emails.md: update links

91de62c

importing_data.md: update links

0543840

fastly_io.md: developer.fastly.com/learning → www.fastly.com/document…

984d6a7

…ation

install_ibexa_dxp.md: Update how-to-install-lamp-stack-on-ubuntu link

a71b1e1

install_with_ddev.md: Update get-docker

53b0c9e

install_ibexa_dxp.md: Update link to prod HTTP server

68957d6

Section renamed in #2422 with content not changed.

requirements.md: Update Redis doc links

caba85b

ibexa_commerce.md: Fix anchor link syntax ##→#

ae81ecc

fastly.md: developer.fastly.com/reference → www.fastly.com/documentat…

22c20e4

…ion/reference

reverse_proxy.md: developer.fastly.com/learning → www.fastly.com/docu…

2bc7231

…mentation/reference

persistence_cache.md: Update redis doc links

7dbab5d

persistence_cache.md: Update Google Cloud link

ea8a2a6

clustering_with_ddev.md: Update jq homepage

00a0880

clustering_with_ddev.md: Update Redis doc links

7a9faa8

sessions.md: Update Redis doc links

559b699

siteaccess_matching.md: rm PHP doc example anchor

f1142ee

It often changes without any consistency https://web.archive.org/web/*/https://www.php.net/manual/en/install.fpm.configuration.php

install_elasticsearch.md: Update Docker overview link

89b9d51

install_solr.md: Update Solr docs links

b969c95

date_twig_filters.md: update anchor

cd40779

formatting_date_and_time.md: section was renamed in #2506

adriendupuis commented Feb 15, 2025

View reviewed changes

docs/multisite/siteaccess/siteaccess_matching.md Show resolved Hide resolved

adriendupuis marked this pull request as ready for review February 17, 2025 08:36

adriendupuis added the Needs DOC review label Feb 17, 2025

adriendupuis commented Feb 17, 2025

View reviewed changes

adriendupuis added 2 commits February 17, 2025 12:25

new_in_doc.md: Add trailing / to few links

b2e72af

new_in_doc.md: target latest instead of master

f625465

adriendupuis force-pushed the fix-links branch from 3813337 to f625465 Compare February 17, 2025 13:53

mnocon reviewed Feb 17, 2025

View reviewed changes

docs/commerce/payment/enable_paypal_payments.md Outdated Show resolved Hide resolved

docs/commerce/transactional_emails/transactional_emails.md Outdated Show resolved Hide resolved

docs/search/search_engines/solr_search_engine/install_solr.md Outdated Show resolved Hide resolved

Apply suggestions from code review

17fc408

Co-authored-by: Marek Nocoń <[email protected]>

adriendupuis requested review from mnocon and dabrt February 17, 2025 16:28

This was referenced Feb 17, 2025

Fix links 4.6 #2618

Draft

Fix links 3.3 #2619

Draft

mnocon approved these changes Feb 17, 2025

View reviewed changes

dabrt approved these changes Feb 18, 2025

View reviewed changes

adriendupuis added Ready for MERGE and removed Needs DOC review labels Feb 19, 2025

adriendupuis added 4 commits February 19, 2025 11:06

Merge branch 'master' into fix-links

ed1de59

site_factory_configuration.md: Fix "assigning roles" link

4f2c17e

site_factory_configuration.md: "assigning roles" link w/ [[= user_doc…

011dd5f

… =]]

Merge branch 'master' into fix-links

87f01d3

# Conflicts: # docs/content_management/images/fastly_io.md

adriendupuis merged commit 826c6f7 into master Feb 19, 2025
6 of 7 checks passed

adriendupuis deleted the fix-links branch February 19, 2025 13:08

adriendupuis added a commit that referenced this pull request Feb 19, 2025

Fix links (#2614)

cb4e0ba

(cherry picked from commit 826c6f7)

adriendupuis mentioned this pull request Feb 20, 2025

Fix links #2625

Draft

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix links #2614

Fix links #2614

adriendupuis commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading

adriendupuis Feb 17, 2025 •

edited

Loading

mnocon Feb 17, 2025

mnocon Feb 17, 2025 •

edited

Loading

dabrt Feb 17, 2025 •

edited

Loading

mnocon Feb 17, 2025 •

edited

Loading

mnocon Feb 17, 2025

adriendupuis Feb 17, 2025

adriendupuis Feb 17, 2025

mnocon left a comment

	user_doc: 'https://doc.ibexa.co/projects/userguide/en/master'
	user_doc: 'https://doc.ibexa.co/projects/userguide/en/latest'

Fix links #2614

Fix links #2614

Conversation

adriendupuis commented Feb 14, 2025 • edited Loading

Checklist

github-actions bot commented Feb 14, 2025 • edited Loading

adriendupuis Feb 17, 2025 • edited Loading

Choose a reason for hiding this comment

mnocon Feb 17, 2025

Choose a reason for hiding this comment

mnocon Feb 17, 2025 • edited Loading

Choose a reason for hiding this comment

dabrt Feb 17, 2025 • edited Loading

Choose a reason for hiding this comment

mnocon Feb 17, 2025 • edited Loading

Choose a reason for hiding this comment

mnocon Feb 17, 2025

Choose a reason for hiding this comment

adriendupuis Feb 17, 2025

Choose a reason for hiding this comment

adriendupuis Feb 17, 2025

Choose a reason for hiding this comment

mnocon left a comment

Choose a reason for hiding this comment

adriendupuis commented Feb 14, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading

adriendupuis Feb 17, 2025 •

edited

Loading

mnocon Feb 17, 2025 •

edited

Loading

dabrt Feb 17, 2025 •

edited

Loading

mnocon Feb 17, 2025 •

edited

Loading