diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..daa5001 --- /dev/null +++ b/LICENSE @@ -0,0 +1,28 @@ +The Mastodon comments mechanism is by Carl Schwan CC-BY-SA: + +https://carlschwan.eu/2020/12/29/adding-comments-to-your-static-blog-with-mastodon/ + +The file in templates/, bootstrap.min.css, bootstrap.min.js, and local.css +are derived from bootstrap. They and all remaining files are licensed under +the MIT license: + +Copyright (c) 2011-2015 Twitter, Inc +Copyright (c) 2009-2015 Julian Andres Klode + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README/index.html b/README/index.html new file mode 100644 index 0000000..a893225 --- /dev/null +++ b/README/index.html @@ -0,0 +1,231 @@ + + + + + + + + + + README - ilot.io + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+

ilot.io

+ +

Upstream: https://forge.ilot.io/ilot/ilot.io

+ +

Build Status +Push Status

+ +

Forgejo Actions

+ +

This project's static Pages are built by Forgejo Actions, following the steps +defined in .forgejo/workflows/pages.yaml. +That builds this website using ikiwiki, and pushes the build artifacts to the +public branch.

+ +

The public branch has its own workflow following steps defined in +forgejo/workflows/deploy.yaml +that uploads the artifacts to a remote HTTP server for deployment in +production. This workflow is automatically updated from main so that public +should never be manually modified.

+ +

The deployment is done by a simple remote git push via SSH to a non-bare repo +where git config receive.denyCurrentBranch is set as updateInstead. This +allows this repo to be checked out as public, allowing it to be a root for +your favorite HTTP server.

+ +

The following secrets are expected to be set for operation: +* PAGES_PRIVKEY: SSH private key that is used to push to the HTTP server's git +repo +* PAGES_TOKEN: Forgejo application token used to push to public branch.

+ +

The following variables are expected to be set for operation: +* PAGES_TARGET: SSH target for HTTP server's git repo, following this format: +user@example.net:/path/to/http/repo

+ +

Building locally

+ +

To work locally with this project, you'll have to follow the steps below:

+ +
    +
  1. Fork, clone or download this project
  2. +
  3. Install ikiwiki: +
  4. +
  5. Generate the website: ikiwiki --setup ikiwiki.setup
  6. +
  7. Start http-server: ./test-server.sh
  8. +
  9. Preview your project: open 127.0.0.1:8080 in your browser
  10. +
+ +

Read more at ikiwiki's documentation.

+ +

Contributing

+ +
    +
  1. Fork the main ilot.io repo.

  2. +
  3. Checkout the forked repository.

    + +
      +
    • git clone ssh://git@forge.ilot.io/$USER/ilot.io
    • +
    • cd ilot.io
    • +
  4. +
  5. Make your changes.

  6. +
  7. Do local build.

    + +
      +
    • ikiwiki --setup ikiwiki.setup
    • +
  8. +
  9. Fix any errors that come up and rebuild until it works locally.

  10. +
  11. Commit the changes to the git repo in a git branch

    + +
      +
    • git checkout -b <name>
    • +
    • git add changes
    • +
    • git commit -m 'content/index: descriptive description'
    • +
    • git push
    • +
  12. +
  13. Create a merge request with your changes by following link in server response.

  14. +
  15. Once the tests in the merge-request pass, and reviewers are happy, your changes +will be merged.

  16. +
+ + + + +
+
+ + + + + + + + + + + diff --git a/footer/index.en.html b/footer/index.en.html index 2cd3503..86ecf22 100644 --- a/footer/index.en.html +++ b/footer/index.en.html @@ -50,7 +50,7 @@ - +