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

Upgrade secondaries plugin resolves multiple issues #245

Merged
merged 5 commits into from Jun 9, 2023
Merged

Conversation

finanalyst
Copy link
Collaborator

Creates secondary files with names that can have unicode characters, Filesystem characters. Improves escaping in search bar. Improves content of secondary files.

Creates secondary files with names that can have unicode characters, Filesystem characters. Improves escaping in search bar. Improves content of secondary files.
- Discussion of urls in discussion #99
- resolves long outstanding issue #198 (from Raku/doc, 2019)
- resolves issue #70 about <==
- resolves issue #181 about pages not being generated
To handle `=head1 X<Function name|Syntax, name>` type blocks, more information is needed from `Raku::Pod::Render`. Fez is not accepting the updated distribution.
This PR is likely to fail until Fez issue is resolved.
@finanalyst finanalyst requested a review from coke April 30, 2023 21:20
@finanalyst
Copy link
Collaborator Author

This PR is failing because it relies on Raku::Pod::Render:ver<4.5.1+> but changes in fez are delaying the acceptance of this version into the ecosystem.
I will post another comment when build kite begins to pass the tests.

The map directive is well documented. The prettyurls file is generated when the html are built. Essentially, secondary files are generated with human-readable characters, including `/` and unicode. These are hash encoded and mapped to files in the `hashed/` directory.
The route directive was added after discussion with the Caddy maintainer. Basically, Caddy by default runs `try_files` before `error`, which generate errors for given routes. Since we want `/hashed*` routes to be illegal from the outside, `errors` must run before the `try_files` directive.
@finanalyst
Copy link
Collaborator Author

The result of this refactor, running off a Caddy server with the new Caddyfile can be seen at new-raku. Try searching for $/.

Copy link
Contributor

@coke coke left a comment

Choose a reason for hiding this comment

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

Some quick questions, may have more.

Website/plugins/search-bar/add-search.raku Outdated Show resolved Hide resolved
Website/plugins/secondaries/gen-secondaries.raku Outdated Show resolved Hide resolved
Website/plugins/secondaries/gen-secondaries.raku Outdated Show resolved Hide resolved
@coke
Copy link
Contributor

coke commented May 5, 2023

Need to address the conflicts.

@finanalyst
Copy link
Collaborator Author

@coke This refactoring will not build until Raku::Pod::Render update can be uploaded using fez.

The problem is a bug in fez which will be fixed in release 52. Once that lands, I will fix up the other conflicts here.

@finanalyst finanalyst mentioned this pull request May 7, 2023
@dontlaugh
Copy link
Collaborator

Bug in fez

Can you elaborate?

@finanalyst
Copy link
Collaborator Author

The issue is raised in the fez repo, and a fix is forthcoming.

@finanalyst
Copy link
Collaborator Author

@coke @dontlaugh fez v-52 is now available and Collection and Raku::Pod::Render have been updated.
The new Raku::Pod::Render expects two templates that were previously undocumented. PR #256 fixes this.
#256 is a small change, so that one needs approving and merging first. Then we can take another look at this PR
Merging #256 should allow the build step to pass here too.

@finanalyst
Copy link
Collaborator Author

The build is now passing, the conflicts have been resolved.
@dontlaugh This PR includes some changes to the caddy file config. I had to go to the Caddy community to get an answer, found a bug, got a badge for the contribution :)
The patch works on new-raku, but now I need to see if it will run OK on doc-website.
@coke conflicts resolved

@finanalyst finanalyst requested a review from coke June 9, 2023 06:58
@coke
Copy link
Contributor

coke commented Jun 9, 2023

Doing a merge commit, since rebase was off the table and there were multiple commits I didn't want to squash.

@coke coke merged commit 0c574e2 into main Jun 9, 2023
@coke coke deleted the secondary_refactor branch June 9, 2023 13:13
@coke coke added this to the 2023-Quarter 2 milestone Jun 22, 2023
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.

None yet

3 participants