#10243 Redirect for Workstation docs
Closed: Will Not/Can Not fix 2 years ago by aday. Opened 2 years ago by aday.

Describe what you would like us to do:


Set up a redirect from https://docs.fedoraproject.org/en-US/workstation-working-group/main/ to https://docs.fedoraproject.org/en-US/workstation-working-group/

Reason: the /main suffix is due to the mainline branch being called main and not master. Apparently this issue will be resolved fairly soon, and the workstation WG would prefer not to have to change the name of the mainline branch as a temporary fix.

When do you need this to be done by? (YYYY/MM/DD)


It's not urgent, but in the next week would be nice: 2021/10/05

CC @ngompa


Why not just make the url's not use the git branch?

Metadata Update from @mohanboddu:
- Issue tagged with: medium-gain, medium-trouble, ops

2 years ago

Why not just make the url's not use the git branch?

That's the issue with the Antora docs currently - it doesn't use the branch in the URL when the branch name is master, but otherwise it does. A fix is expected for this, to make it ignore the branch whatever its name.

In the meantime, we either need to rename the mainline branch to be master (which is something we'd prefer not to do), or get this redirect.

Metadata Update from @mohanboddu:
- Issue priority set to: Waiting on Assignee (was: Needs Review)

2 years ago

This redirect should be live in an hour or so once the playbook completes running.

Please let us know when it's no longer needed and we can remove it.

Metadata Update from @kevin:
- Issue close_status updated to: Fixed
- Issue status updated to: Closed (was: Open)

2 years ago

Issue status updated to: Open (was: Closed)

2 years ago

Metadata Update from @jbley:
- Issue close_status updated to: Fixed
- Issue status updated to: Closed (was: Open)

2 years ago

Thanks for working on this, @kevin

Unfortunately the change doesn't seem to be having the intended effect. For both https://docs.fedoraproject.org//en-US/workstation-working-group/main/ and https://docs.fedoraproject.org//en-US/workstation-working-group/ , I get an "The page isn’t redirecting properly" error (Firefox). Chrome gives me ERR_TOO_MANY_REDIRECTS.

The goal was to have https://docs.fedoraproject.org//en-US/workstation-working-group/ show the content that was previously being displayed at https://docs.fedoraproject.org//en-US/workstation-working-group/main/ .

Metadata Update from @aday:
- Issue status updated to: Open (was: Closed)

2 years ago

So, I just spent like an hour trying to get this to work without much luck. This work was hampered by the fact that this site doesn't appear to be building in staging, so it's difficult to test it. ;(

Apache redirect/redirectmatch are a pain and redirecting foo/ to /foo/bar without causing a loop is proving difficult. :(

Are you sure we can't just fix this in docs? Is there an upstream docs ticket/issue on this, or someone who is working on fixing it?

Thanks for spending so much time on this, @kevin . I hadn't wanted to cause you this much work.

I'm currently trying to track down details of the work to support our configuration in the docs site itself. I assume we'll either need to wait for that, or change the name of our default branch.

@kevin , if you could remove the redirect you put in place, I guess I'll just rename the default branch to master. Sorry for the trouble...

I think there is a misunderstanding here.
The /main/ in the published docs url is not related any Git branches.
It appears because at workstation-docs/antora.yml you have defined version: main.
That is an Antora configuration thing, not Git.
Antora just happens to use the same hardcoded default as Git used to have,
master standing for the default version (resp. branch).
Just keep main as the default branch,
refer to it in the docs-fp-o config,
but use version: master in the antora.yml of your repository
and everything will be fine, Git-wise.
Antora will still require the string master,
that will change with Antora 3,
then you can (must?) use version: ~ in antora.yml.

For example, kinoite-docs has been configured this way
and works well.

Thanks for the clarification, @oturpe !

ok, the redirect should be completely gone now.

ok, the redirect should be completely gone now.

Thanks @kevin , and sorry for the trouble.

Metadata Update from @aday:
- Issue close_status updated to: Will Not/Can Not fix
- Issue status updated to: Closed (was: Open)

2 years ago

Login to comment on this ticket.

Metadata
Boards 1
ops Status: Backlog