Synchronize documentation with other Galaxy projects

.github/workflows/check-pull-request.yaml → .github/workflows/build-pull-request.yaml

@@ -1,13 +1,12 @@
-name: check-pull-request
+name: Build pull request
 
 on: pull_request
 
 jobs:
-  check-pull-request:
+  build-pull-request:
     runs-on: macos-latest
 
     steps:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 #v4.1.7
       - run: |
-          ./gradlew build
-          ./gradlew -p tests build
+          ./gradlew build 

.github/workflows/publish-doc.yaml → .github/workflows/publish-docs.yaml

@@ -2,35 +2,47 @@ name: Publish documentation
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   workflow_dispatch:
 
+env:
+  INSTANCE: 'Writerside/doc'
+  ARTIFACT: 'webHelpDOC2-all.zip'
+  DOCKER_VERSION: '241.16003'
+
 jobs:
-  build:
+  build-docs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 #v4.1.7
         with:
           fetch-depth: 0
 
+      - name: Build docs using Writerside Docker builder
+        uses: JetBrains/writerside-github-action@5a6920dbce3ef3169acbeb7e45c6cbdaf7e76bfa #v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: ${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+
       - name: Prepare static content
         run: |
-          export JAVA_HOME=$JAVA_HOME_21_X64
           ./gradlew dokkatooGeneratePublicationHtml
           mkdir -p build/static
-          cp -rf build/dokka build/static/kdoc
+          cp -rf build/dokka/html build/static/kdoc
+          unzip artifacts/webHelpDOC2-all.zip -d build/static
 
       - name: Deploy Kdoc to github pages
         uses: JamesIves/github-pages-deploy-action@5c6e9e9f3672ce8fd37b9856193d2a537941e66c #v4.6.1
         with:
           branch: gh-pages # The branch the action should deploy to.
-          folder: build/static/kdoc/html # The folder the action should deploy.
+          folder: build/static # The folder the action should deploy.
 
       - name: Save artifact with build results
         uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 #v4.3.3
         with:
           name: docs
           path: |
             artifacts/${{ env.ARTIFACT }}
-          retention-days: 7
+          retention-days: 7

.github/workflows/publish-release.yaml

@@ -1,4 +1,4 @@
-name: publish-release
+name: Publish release
 
 on:
   workflow_dispatch:
@@ -13,11 +13,11 @@ jobs:
     steps:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 #v4.1.7
       - run: |
-          ./gradlew librarianReleaseStagingRepo
+          ./gradlew librarianPublishToMavenCentral
           gh release create $GITHUB_REF_NAME --title $GITHUB_REF_NAME --verify-tag --notes-from-tag
         env:
-          LIBRARIAN_SONATYPE_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
-          LIBRARIAN_SONATYPE_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
-          LIBRARIAN_SIGNING_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
-          LIBRARIAN_SIGNING_PRIVATE_KEY_PASSWORD: ${{ secrets.GPG_PRIVATE_KEY_PASSWORD }}
+          LIBRARIAN_SONATYPE_USERNAME: ${{ secrets.LIBRARIAN_SONATYPE_USERNAME }}
+          LIBRARIAN_SONATYPE_PASSWORD: ${{ secrets.LIBRARIAN_SONATYPE_PASSWORD }}
+          LIBRARIAN_SIGNING_PRIVATE_KEY: ${{ secrets.LIBRARIAN_SIGNING_PRIVATE_KEY }}
+          LIBRARIAN_SIGNING_PRIVATE_KEY_PASSWORD: ${{ secrets.LIBRARIAN_SIGNING_PRIVATE_KEY_PASSWORD }}
           GH_TOKEN: ${{ github.token }}

.github/workflows/publish-snapshot.yaml

@@ -1,4 +1,4 @@
-name: publish-snapshot
+name: Publish snapshot
 
 on:
   push:
@@ -10,9 +10,9 @@ jobs:
     steps:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 #v4.1.7
       - run: |
-          ./gradlew librarianPublishToSnapshots
+          ./gradlew librarianPublishToMavenSnapshots
         env:
-          LIBRARIAN_SONATYPE_USERNAME: ${{ secrets.SONATYPE_NEXUS_USERNAME }}
-          LIBRARIAN_SONATYPE_PASSWORD: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
-          LIBRARIAN_SIGNING_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
-          LIBRARIAN_SIGNING_PRIVATE_KEY_PASSWORD: ${{ secrets.GPG_PRIVATE_KEY_PASSWORD }}
+          LIBRARIAN_SONATYPE_USERNAME: ${{ secrets.LIBRARIAN_SONATYPE_USERNAME }}
+          LIBRARIAN_SONATYPE_PASSWORD: ${{ secrets.LIBRARIAN_SONATYPE_PASSWORD }}
+          LIBRARIAN_SIGNING_PRIVATE_KEY: ${{ secrets.LIBRARIAN_SIGNING_PRIVATE_KEY }}
+          LIBRARIAN_SIGNING_PRIVATE_KEY_PASSWORD: ${{ secrets.LIBRARIAN_SIGNING_PRIVATE_KEY_PASSWORD }}

.gitignore

@@ -11,40 +11,16 @@
 
 # Generated files
 build
-/reports
 .kotlin
 
 # Place where the Android SDK path is set
 local.properties
 
-# Secret used by sample apps
-github_token
-
-# XCode 
+# XCode
 xcuserdata
 project.xcworkspace
 
-# Mac OS Finder 
+# Mac OS Finder
 .DS_Store
 Thumbs.db
-db.json
-*.log
-
-# Docs
-node_modules/
-/docs/public
-/docs/.cache
-!docs/public/_redirects
-.deploy*/
-docs.json
-package-lock.json
-**/.project
-.vscode/**
-**/bin
-.sqldelight
-
-# Local Netlify folder
-.netlify
 
-# IntelliJ plugin
-intellij-plugin/mockJDK

CODEOWNERS

@@ -1 +1 @@
-* @martinbonnin @BoD
+* @martinbonnin @BoD

README.md

@@ -1,3 +1,26 @@
-# Apollo Kotlin Incubating Normalized Cache
+<div align="center">
+
+<p>
+	<a href="https://www.apollographql.com/"><img src="https://raw.githubusercontent.com/apollographql/apollo-client-devtools/a7147d7db5e29b28224821bf238ba8e3a2fdf904/assets/apollo-wordmark.svg" height="100" alt="Apollo Client"></a>
+</p>
+
+[![Discourse](https://img.shields.io/discourse/topics?label=Discourse&server=https%3A%2F%2Fcommunity.apollographql.com&logo=discourse&color=467B95&style=flat-square)](http://community.apollographql.com/new-topic?category=Help&tags=mobile,client)
+[![Slack](https://img.shields.io/static/v1?label=kotlinlang&message=apollo-kotlin&color=A97BFF&logo=slack&style=flat-square)](https://app.slack.com/client/T09229ZC6/C01A6KM1SBZ)
+[![Discord](https://img.shields.io/discord/1022972389463687228.svg?color=7389D8&labelColor=6A7EC2&logo=discord&logoColor=ffffff&style=flat-square)](https://discord.com/invite/graphos)
+
+[![Maven Central](https://img.shields.io/maven-central/v/com.apollographql.cache/normalized-cache-incubating?style=flat-square)](https://central.sonatype.com/namespace/com.apollographql.cache)
+[![OSS Snapshots](https://img.shields.io/nexus/s/com.apollographql.cache/normalized-cache-incubating?server=https%3A%2F%2Fs01.oss.sonatype.org&label=oss-snapshots&style=flat-square)](https://s01.oss.sonatype.org/content/repositories/snapshots/com/apollographql/cache/)
+
+</div>
+
+## 🚀 Apollo Kotlin Normalized Cache Incubating
 
 This repository serves as a place to experiment with [Apollo Kotlin](https://github.com/apollographql/apollo-kotlin)'s normalized cache without impacting the main stable repository.
+
+## 📚 Documentation
+
+See the project website for documentation:<br/>
+[https://apollographql.github.io/apollo-kotlin-normalized-cache-incubating/](https://apollographql.github.io/apollo-kotlin-normalized-cache-incubating/)
+
+The Kdoc API reference can be found at:<br/>
+[https://apollographql.github.io/apollo-kotlin-normalized-cache-incubating/kdoc](https://apollographql.github.io/apollo-kotlin-normalized-cache-incubating/kdoc)

Writerside/c.list

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE categories
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
+<categories>
+    <category id="wrs" name="Writerside documentation" order="1"/>
+</categories>

Writerside/cfg/buildprofiles.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+
+    <variables></variables>
+  <build-profile instance="doc">
+    <variables>
+      <header-logo>apollo_logo.svg</header-logo>
+      <custom-favicons>favicon-96x96.png,favicon-192x192.png</custom-favicons>
+      <noindex-content>true</noindex-content>
+      <download-title>GitHub</download-title>
+      <download-page>https://github.com/apollographql/apollo-kotlin-normalized-cache-incubating/</download-page>
+      <showDownloadButton>true</showDownloadButton>
+      <enable-browser-edits>true</enable-browser-edits>
+      <browser-edits-url>https://github.com/apollographql/apollo-kotlin-normalized-cache-incubating/edit/main/Writerside/</browser-edits-url>
+    </variables>
+  </build-profile>
+</buildprofiles>

Writerside/doc.tree

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE instance-profile
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
+
+<instance-profile id="doc"
+                 name="apollo-kotlin-normalized-cache-incubating"
+                 start-page="welcome.md">
+
+    <toc-element topic="welcome.md"/>
+    <toc-element toc-title="GitHub" href="https://github.com/apollographql/apollo-kotlin-normalized-cache-incubating"/>
+    <toc-element toc-title="Kdoc" href="https://apollographql.github.io/apollo-kotlin-normalized-cache-incubating/kdoc"/>
+</instance-profile>

Writerside/topics/welcome.md

@@ -0,0 +1 @@
+# Welcome

Writerside/v.list

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
+<vars>
+  <var name="product" value="Writerside" />
+  <var name="latest_version" instance="doc" value="0.0.2" type="string" />
+</vars>

Writerside/writerside.cfg

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">
+
+<ihp version="2.0">
+    <topics dir="topics" web-path="topics"/>
+    <images dir="images" web-path="images"/>
+  <instance src="doc.tree" />
+</ihp>

build.gradle.kts

@@ -1,13 +1,11 @@
-import com.gradleup.librarian.core.librarianRoot
+import com.gradleup.librarian.gradle.librarianRoot
 
-buildscript {
-  repositories {
-    mavenCentral()
-    google()
-  }
-  dependencies {
-    classpath("build-logic:build-logic")
-  }
+plugins {
+  alias(libs.plugins.kotlin).apply(false)
+  alias(libs.plugins.android).apply(false)
+  alias(libs.plugins.librarian).apply(false)
+  alias(libs.plugins.atomicfu).apply(false)
+  alias(libs.plugins.sqldelight).apply(false)
 }
 
 librarianRoot()