Build and deploy dev website via CI (FOLIO-832)

[FOLIO-964] Enable clean extension-less URLs Created: 04/Dec/17  Updated: 12/Nov/18  Resolved: 16/Dec/17

Status: Closed
Project: FOLIO
Components: Documentation
Affects versions: None
Fix versions: None
Parent: Build and deploy dev website via CI

Type: Sub-task Priority: P3
Reporter: Peter Murray Assignee: Unassigned
Resolution: Done Votes: 0
Labels: devweb
Remaining Estimate: Not Specified
Time Spent: 5 hours, 40 minutes
Original estimate: Not Specified

Sprint:

 Description   

From comment on FOLIO-832

With the current GitHub Pages build, we do not use the ".html" extension, e.g. dev.folio.org/community/contrib-code
The generated page is there at AWS with the ".html" extension.
Not sure how extension-less URLs are achieved via GitHub, perhaps web server configuration.



 Comments   
Comment by David Crossley [ 04/Dec/17 ]

I did a quick search for extension-less URLs and S3. This one seems useful: https://simpleit.rocks/having-pretty-urls-in-a-jekyll-website-hosted-in-amazon-s3/

Comment by Peter Murray [ 04/Dec/17 ]

Nice find! It seems like that'll do the trick. I'll add it to my post-processing steps.

Comment by David Crossley [ 12/Dec/17 ]

Peter Murray One thing that article warns about is to ensure that there are no existing files that are already extension-less. I scanned the generated "_site" directory of both master and 817 branch. The only such file is "./CNAME".

Comment by Peter Murray [ 12/Dec/17 ]

That shouldn't cause any harm. I don't think that file is directly addressed through the website, is it? For that matter, is it needed? With the S3-website-bucket-per-branch system, I think we'd want all URLs on the site to be relative so that they point to whatever host is used in the URL.

Comment by David Crossley [ 12/Dec/17 ]

Sorry should have clarified. I gather that that is only used for the current github.io deployment.

Ah yes we strive to have relative URLs. Will verify.

Comment by David Crossley [ 13/Dec/17 ]

There was one absolute URL in release-procedures.md (fixed now in both branches). There are some to "curriulum", but that is appropriate at this stage.

So it should be ready now.

Comment by David Crossley [ 14/Dec/17 ]

Put this on hold. I think that there is a solution using Jekyll "permalink". Will test that soon.

Comment by David Crossley [ 16/Dec/17 ]

It works well. Added in pull/127 etc.

Incoming links and internal links do function as expected for both our AWS build and the GitHub pages build. Also existing links with fragment identifiers are still okay.

(Got the idea from the FOLIO-817 Closed theme.)

Generated at Thu Feb 08 23:09:50 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.