Skip to content

Conversation

@01micko
Copy link

@01micko 01micko commented Jul 23, 2022

  • fixes broken link in labwc/README.md

- fixes broken link in labwc/README.md
@johanmalm
Copy link
Member

labwc-environment(5) man page does not exist anymore. There was so little left in it, that I swept it up in labwc-config(5)

To make changes/additions to this site, modify/add markdown files in src/ and run the build-site script. Don’t edit the top-level html files directly.

In the interest of trying to keep the source of truth/data in one place only, the build script auto-builds man pages based on what’s in the labwc repo itself.

@01micko
Copy link
Author

01micko commented Jul 26, 2022

Of course, thanks.

Should we rather delete the link in labwc/README.md?

@01micko 01micko closed this Jul 26, 2022
@01micko 01micko deleted the environment branch July 26, 2022 20:32
@johanmalm
Copy link
Member

Whoops. Good catch.

@Consolatis
Copy link
Member

Consolatis commented Jul 26, 2022

Could this repo use some github action to build the new HTML whenever being pushed to?

Edit: all the HTML files could then also be deleted from the repo I guess.

@johanmalm
Copy link
Member

Not sure if it is worth the faff - running the build-site script is so quick and simple.

The html files need to be committed in the repo for the website to exit (must be some internal github action because it normally takes a few seconds before they show on the website)

The build-script auto builds man pages. I find it useful to do this html conversion locally to before committing man pages to labwc repo.

pros: user does need pandoc installed (although probably want to generate hmtls locally anyway to see what is looks like?)

@Consolatis
Copy link
Member

I don't have a strong opinion to either side, just wondered if it would ease contributions for users.

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.

3 participants