Rework hugo.toml file. #214

stumbo · 2024-03-15T06:06:46Z

Updated 2024.06.12

Replace hugo.toml configuration file with a collection of .yaml files in the config directory. This breaks functionality into smaller chunks that are centered around a specific topic area. That said, the params.yaml file is still a bit of a grab bag of options.

Shared configuration files are in the _default subdirectory directory
Environment specific files are in production, staging and development subdirectories
Added additional comments with configuration options to provide better definition on its purpose
Production environment set to enable Google Analytics, site crawling

Added a robots.txt file that disallows crawling. This file is automatically replaced in when running in production with a version that allows crawling.

Updated Github action to specify environment. Environment is set as an environment variable. This could be further enhanced by passing in a value as a repository secret.

Updates to README.md

Convert to yaml and break into subsections. Move to config directory. Start setup to support Production and Staged deployments

Code Highlighting cleaned up and better commented. Updated `software/install-and-run/windows/native/_index.md` to test and validate code block processing.

stumbo · 2024-03-16T05:42:32Z

Still a work in progress, but I want to start socializing the work. This PR starts cleaning up the hugo.toml file. I'm trying to figure out what parts are antiquated and no longer used and document the options that we are using. Where possible I'm trying to add in links back into the Docsy or Hugo documentation where the options are more fully explained.

As part of this activity, I've converted from toml to yaml -- it's a bit of a personal choice, in that I find the yaml easier to read.

Hugo now lets me divide the configuration information across multiple files, which should help colocate information. There is some top level information in the hugo.yaml file that doesn't neatly fit into a sub-file based on the naming conventions.

A follow on activity will be creating environment specific files for deploying to production, staging or running locally. I haven't put a lot of effort into those files yet.

masinter · 2024-03-21T16:09:35Z

config/_default/params.yaml

+    enable: true
+    yes: 'Glad to hear it! Please <a href="https://github.com/Interlisp/medley/issues/new?template=documentation.md&projects=Interlisp/medley/5">tell us how we can improve</a>.'
+    no: 'Sorry to hear that. Please <a href="https://github.com/Interlisp/medley/issues/new?template=documentation.md&projects=Interlisp/medley/5">tell us how we can improve</a>.'
+


I like the idea of per-page asking for feedback, but I havent seen any.
Is it how we're asking?

Possibly - I really have no idea how much feedback other sites get from this type of setup.

But, I can imagine that with longer documents you have an issue with users even getting to the feedback button. If, the information isn't useful, they'll be long gone before they get to it.

masinter · 2024-03-21T16:12:34Z

config/_default/privacy.yaml

+#  respectDoNotTrack:  Check for Do Not Track in headers
+#  useSessionStorage:  Store session information in storage and
+#                      not in cookies
+privacy:


what and where is our "privacy policy" and does everyone know?
What do we want to say about our non-promise of privacy when using online? (For diagnostic purposes etc)

This is new to us -- it is one of the areas I noticed in poking around. I took an initial cut at settings, but I'm open to suggestions. I would like someone that understand GDPR to weigh in and suggest any needed changes.

masinter · 2024-03-21T16:22:00Z

content/en/software/install-and-run/windows/native/_index.md


 ## Important Notes
-1. The file system from Medley's perspective differs somewhat from the file system from Window's perspective.   Specifically, within Medley, the file system root (i.e., "{DSK}/" or "{UNIX}/") is mapped to the ***install_dir*** in the Windows file system.  For example, if ***install_dir*** is ***C:\Users\Frank\Medley1***, then the Medley file known as ***{DSK}\<testdir>testfile.txt*** will be located in the Windows file system at  ***C:\Users\Frank\Medley1\testdir\testfile.txt*** 
+
+1. The file system from Medley's perspective differs somewhat from the file system from Window's perspective.   Specifically, within Medley, the file system root (i.e., "{DSK}/" or "{UNIX}/") is mapped to the ***install_dir*** in the Windows file system.  For example, if ***install_dir*** is ***C:\Users\Frank\Medley1***, then the Medley file known as ***{DSK}\<testdir>testfile.txt*** will be located in the Windows file system at  ***C:\Users\Frank\Medley1\testdir\testfile.txt***

 2. Also, from Medley you can refer to any file on a Windows drive using the reference ***{DSK}/[drive letter]/*** (or equivalently ***{DSK}<[drive letter]>***).  For example, ***C:\User\Frank\Downloads\testfile.txt*** in Windows will be  ***{DSK}/c/User/Frank/Downloads/testfile.txt*** in Medley.



unfortunately this section depends on "native" vs "wsl". With wsl, the drive letter is prefixed with /mnt/<driveletter>, e.g.,

{DSK}/mnt/d/Users/Frank/Downloads/testfile.txt or {DSK}<mnt>c>Users>Frank>Downloads/testfile.txt

OK - my changes in this section were only editorial, cleaning up some of the markdown and using it to validate the code highlighting was working correctly - the addition of powershell on lines 53 and 63 will cause the markdown the code blocks to have syntactical highlighting for powershell. The blank lines I added are bring the formatting into compliance with standard markdown formatting.

http://localhost:1313/# Please enter the commit message for your changes. Lines starting

Update peaceiris action versions and github action versions.

…o into docsyUpdate

File used in local development setup

masinter · 2024-06-09T18:09:09Z

On Linux in WSL, a user would find the windows file system by using /mnt/drive-letter/ e.g., you will find C:\Users\Larry at {DSK}/mnt/c/users/larry (or should this say {DSK}<mnt>c>Users>Larry>. Before we get to far, should we change the cygwin installation to use /mnt/drive-letter vs /drive-letter

Or at least point out the difference in the two setups?

There was at one time a interlisp.org/software/ page on the file system(s) mappings.

stumbo · 2024-06-21T02:57:18Z

On Linux in WSL, a user would find the windows file system by using /mnt/drive-letter/ e.g., you will find C:\Users\Larry at {DSK}/mnt/c/users/larry (or should this say {DSK}<mnt>c>Users>Larry>. Before we get to far, should we change the cygwin installation to use /mnt/drive-letter vs /drive-letter

Or at least point out the difference in the two setups?

There was at one time a interlisp.org/software/ page on the file system(s) mappings.

@masinter Larry - I'm not sure how to address this comment. Is there a specific file that this comment relates to? I need some more context to figure out what, if anything, to do with it.

masinter · 2024-06-21T03:40:39Z

ask @lispcore or at least @fghalasz who set up the cygwin mount points. I think in general the idea is if you can't decide, ask someone else for an opinion.

fghalasz

LGTM. toml->y(a)ml changes look ok and work just fine on a local Hugo server. Editorial fixes all OK.

stumbo added 3 commits March 15, 2024 02:04

Rework hugo.toml file.

4f134bc

Convert to yaml and break into subsections. Move to config directory. Start setup to support Production and Staged deployments

Round 2 of updates

4eabd13

Continued cleanup of config files

c4c8eb1

Code Highlighting cleaned up and better commented. Updated `software/install-and-run/windows/native/_index.md` to test and validate code block processing.

stumbo requested review from fghalasz, masinter and phantomics March 16, 2024 05:36

stumbo added 2 commits March 16, 2024 08:25

Merge remote-tracking branch 'origin/main' into staging

26d5657

Update

fce7f3e

masinter reviewed Mar 21, 2024

View reviewed changes

stumbo added 11 commits May 22, 2024 14:44

Update docsy version to 0.10.0

2e190ab

http://localhost:1313/# Please enter the commit message for your changes. Lines starting

Cleanup deprecated options

c41140a

Updates to bring fix deprecated config items, fix local search

1684af4

Update github action setting directories correctly.

f43bdbb

Update peaceiris action versions and github action versions.

Merge branch 'main' into docsyUpdate

24046f8

Add .gitkeep file

0991d88

Merge branch 'docsyUpdate' of github.com:Interlisp/interlisp.github.i…

2832ecf

…o into docsyUpdate

Cleanup

733744e

Add config/development/server.yaml

354a761

File used in local development setup

Merge branch 'docsyUpdate' into staging2

2dfc6e3

Update Twitter logo to X

2478261

stumbo added 3 commits June 9, 2024 23:24

Merge branch 'main' into staging

be84b10

Cleanup and syncronize changes with private branch

830126d

Additional cleanup

eb32c06

stumbo self-assigned this Jun 12, 2024

stumbo marked this pull request as ready for review June 12, 2024 11:29

Merge branch 'main' into staging

0c97b5f

fghalasz approved these changes Jun 26, 2024

View reviewed changes

stumbo merged commit fe70f7b into main Jun 26, 2024

stumbo deleted the staging branch June 26, 2024 18:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Rework hugo.toml file. #214

Rework hugo.toml file. #214

Uh oh!

stumbo commented Mar 15, 2024 •

edited

Loading

Uh oh!

stumbo commented Mar 16, 2024

Uh oh!

masinter Mar 21, 2024

Uh oh!

stumbo Mar 22, 2024

Uh oh!

masinter Mar 21, 2024

Uh oh!

stumbo Mar 22, 2024

Uh oh!

masinter Mar 21, 2024

Uh oh!

stumbo Mar 22, 2024

Uh oh!

masinter commented Jun 9, 2024

Uh oh!

stumbo commented Jun 21, 2024

Uh oh!

masinter commented Jun 21, 2024

Uh oh!

fghalasz left a comment

Uh oh!

Uh oh!

Uh oh!

Rework hugo.toml file. #214

Rework hugo.toml file. #214

Uh oh!

Conversation

stumbo commented Mar 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stumbo commented Mar 16, 2024

Uh oh!

masinter Mar 21, 2024

Choose a reason for hiding this comment

Uh oh!

stumbo Mar 22, 2024

Choose a reason for hiding this comment

Uh oh!

masinter Mar 21, 2024

Choose a reason for hiding this comment

Uh oh!

stumbo Mar 22, 2024

Choose a reason for hiding this comment

Uh oh!

masinter Mar 21, 2024

Choose a reason for hiding this comment

Uh oh!

stumbo Mar 22, 2024

Choose a reason for hiding this comment

Uh oh!

masinter commented Jun 9, 2024

Uh oh!

stumbo commented Jun 21, 2024

Uh oh!

masinter commented Jun 21, 2024

Uh oh!

fghalasz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stumbo commented Mar 15, 2024 •

edited

Loading