better install instructions (#95)

* cleaning quick start

* better install instructions

---------

Co-authored-by: Michele Sciabarra <michele@sciabarra.com>
4 files changed
tree: 133b9bb3e4d4a7188edb9320f9986861350fa85b
  1. .github/
  2. assets/
  3. content/
  4. i18n/
  5. layouts/
  6. static/
  7. tasks/
  8. .asf.yaml
  9. .envrc
  10. .gitignore
  11. .nvmrc
  12. DISCLAIMER
  13. docsy.work
  14. docsy.work.sum
  15. go.mod
  16. go.sum
  17. hugo.yaml
  18. LICENSE
  19. netlify.toml
  20. NOTICE
  21. package.json
  22. postcss.config.js
  23. README.md
  24. shell.nix
  25. Taskfile.yaml
  26. tools.md
README.md

Apache OpenServerless documentation

The Apache OpenServerless website uses Hugo and Docsy to build static HTML and related resources.

Prerequisites

  • Ensure to have a recent nodejs and npm version or use Nix to get dependencies (we provide a shell.nix)
  • Install Taskfile
  • Clone repository
    • git clone https://github.com/apache/openserverless-site.git
    • npm install

Preview

Task and Tools updates

The documentation for OpenServerless Tasks and OpenServerless Tools is automatically extracted from the respective repositories.

Is possible to align task, tools and runtimes using these commands:

  • Tasks

    • task import-task
  • Tools

    • task import-tools
  • Runtimes

    • task import-runtimes

Web site build

  • Run Hugo Build
    • task build

Publish

The Apache OpenServerless website uses GitHub Actions and Apache Software Foundation Infrastructure configuration for automated publishing.