Set up microsite (#4)

* Set up the microsite template

* Set up microsite CI

* Change doc titles

* Fix broken links

* Remove empty lines

* Change from TODO to TBD

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Setup Java
-        uses: actions/setup-java@v3.1.1
+        uses: actions/setup-java@v3.4.1
         with:
           distribution: temurin
           java-version: 17
@@ -43,7 +43,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Setup Java
-        uses: actions/setup-java@v3.1.1
+        uses: actions/setup-java@v3.4.1
         with:
           distribution: temurin
           java-version: ${{ matrix.java }}
@@ -53,9 +53,26 @@ jobs:
       - name: Run tests
         run: ./sbt ++${{ matrix.scala }}! test
 
+  website:
+    runs-on: ubuntu-20.04
+    timeout-minutes: 10
+    steps:
+      - name: Checkout current branch
+        uses: actions/[email protected]
+      - name: Setup Java
+        uses: actions/[email protected]
+        with:
+          distribution: temurin
+          java-version: 17
+          check-latest: true
+      - name: Cache scala dependencies
+        uses: coursier/cache-action@v6
+      - name: Check Website Generation
+        run: ./sbt docs/docusaurusCreateSite
+
   ci:
     runs-on: ubuntu-20.04
-    needs: [lint, test]
+    needs: [lint, test, website]
     steps:
       - name: Aggregate outcomes
         run: echo "build succeeded"

.github/workflows/site.yml

@@ -0,0 +1,27 @@
+name: Website
+
+on:
+  push:
+    branches:
+      - 'main'
+  release:
+    types:
+      - published
+
+jobs:
+  publish:
+    runs-on: ubuntu-20.04
+    timeout-minutes: 30
+    steps:
+      - name: Checkout current branch
+        uses: actions/checkout@v3
+      - name: Setup Java
+        uses: actions/[email protected]
+        with:
+          distribution: temurin
+          java-version: 17
+          check-latest: true
+      - name: Publish the site
+        run: ./sbt docs/docusaurusPublishGhpages
+        env:
+          GIT_DEPLOY_KEY: ${{ secrets.GIT_DEPLOY_KEY }}

build.sbt

@@ -37,3 +37,20 @@ lazy val example =
     .settings(
       publish / skip := true
     )
+
+lazy val docs =
+  project
+    .in(file("modules/zio-elasticsearch-docs"))
+    .enablePlugins(MdocPlugin, DocusaurusPlugin, ScalaUnidocPlugin)
+    .dependsOn(library)
+    .settings(
+      publish / skip := true,
+      moduleName     := "zio-elasticsearch-docs",
+      scalacOptions -= "-Yno-imports",
+      scalacOptions -= "-Xfatal-warnings",
+      ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(library),
+      ScalaUnidoc / unidoc / target              := (LocalRootProject / baseDirectory).value / "website" / "static" / "api",
+      cleanFiles += (ScalaUnidoc / unidoc / target).value,
+      docusaurusCreateSite     := docusaurusCreateSite.dependsOn(Compile / unidoc).value,
+      docusaurusPublishGhpages := docusaurusPublishGhpages.dependsOn(Compile / unidoc).value
+    )

docs/about/code_of_conduct.md

@@ -0,0 +1,135 @@
+---
+id: about_code_of_conduct
+title: "Code of Conduct"
+---
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

docs/about/contributing.md

@@ -0,0 +1,37 @@
+---
+id: about_contributing
+title: "Contributing"
+---
+
+We welcome contributions from anybody wishing to participate. All code or documentation that is provided must be licensed under [Apache 2.0](https://github.com/lambdaworks/zio-elasticsearch/blob/main/LICENSE).
+
+## General Workflow
+
+1. Make sure you can license your work under Apache 2.0.
+
+2. Before starting work, make sure there is a ticket on the issue, and if not, make sure to create one. It can help accelerate the acceptance process if the change is agreed upon.
+
+3. If you don't have write access to the repository, you should do your work on a local branch of your own fork. If you do have write access to the repository, you should avoid working directly on the main branch.
+
+4. When your work is completed, verify it with following commands:
+
+```
+sbt check
+sbt +test
+```
+
+5. Submit a Pull Request.
+
+6. Anyone can comment on a Pull Request, and you are expected to answer questions or to incorporate feedback.
+
+## General Guidelines
+
+- We recommend for the work to be accompanied by unit tests.
+
+- The commit messages should be clear and short, and if more details are needed, specify a body.
+
+- Follow the structure of the code in this repository, and the formatting rules used. You can format your code properly with the following command:
+
+```
+sbt prepare
+```

docs/about/index.md

@@ -0,0 +1,6 @@
+---
+id: about_index
+title: "About ZIO Elasticsearch"
+---
+
+TBD

docs/overview/index.md

@@ -0,0 +1,6 @@
+---
+id: overview_index
+title: "Summary"
+---
+
+TBD

project/plugins.sbt

@@ -1,2 +1,4 @@
-addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.10.1")
-addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.6")
+addSbtPlugin("ch.epfl.scala"  % "sbt-scalafix" % "0.10.1")
+addSbtPlugin("org.scalameta"  % "sbt-scalafmt" % "2.4.6")
+addSbtPlugin("org.scalameta"  % "sbt-mdoc"     % "2.3.3")
+addSbtPlugin("com.github.sbt" % "sbt-unidoc"   % "0.5.0")

website/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};