Merge pull request #204 from kube-logging/updates-for-4.5

Doc sync and source fixes for 4.5

Author: pepov

.github/workflows/publish-version-4.4.yaml

@@ -0,0 +1,86 @@
+name: Publish version 4.4
+
+env:
+  doc_versionnumber: "4.4"
+
+on:
+  push:
+    branches:
+      - release-4.4
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+    
+    concurrency:
+      group: "pages"
+      cancel-in-progress: false
+    
+    environment:
+      name: github-pages-test
+      url: ${{ steps.deployment.outputs.page_url }}
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          ref: release-4.4
+          submodules: 'recursive'
+
+      - name: Set up Pages
+        id: pages
+        uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4.0.0
+
+      - name: Set up Hugo
+        uses: peaceiris/actions-hugo@16361eb4acea8698b220b76c0d4e84e1fd22c61d # v2.6.0
+        with:
+          hugo-version: '0.110.0'
+          extended: true
+
+      - name: Set up Node
+        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
+        with:
+          node-version: 16
+
+      - name: Install dependencies
+        run: |
+          cd themes/docsy
+          npm install
+
+      - name: Set up PostCSS
+        run: npm install --save-dev autoprefixer postcss-cli postcss
+
+      - name: Build
+        run: hugo --environment production --baseURL ${{ steps.pages.outputs.base_url }}/${{ env.doc_versionnumber }}/
+
+      # - name: Upload artifact
+      #   uses: actions/upload-pages-artifact@64bcae551a7b18bcb9a09042ddf1960979799187 # v1.0.8
+      #   with:
+      #     path: ./public/
+
+      - name: Checkout code to update
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          ref: 'gh-pages-test'
+          path: 'tmp/gh-pages'
+      # - name: Display file structure
+      #   run: ls -R
+      - name: Copy built site to GH pages
+        run: |
+          rm -rf tmp/gh-pages/${{ env.doc_versionnumber }}
+          mkdir -p tmp/gh-pages/${{ env.doc_versionnumber }}
+          mv public/* tmp/gh-pages/${{ env.doc_versionnumber }}
+      - name: Commit & Push changes
+        uses: actions-js/push@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          message: 'Publish updated docs for ${{ env.doc_versionnumber }}, ${{ github.event.repository.pushed_at}}'
+          branch: 'gh-pages-test'
+          directory: 'tmp/gh-pages'

.htmltest.yml

@@ -0,0 +1,8 @@
+DirectoryPath: public/docs/install
+CheckDoctype: false # Sadly, this is false only because of `static/google*.html`
+IgnoreAltMissing: true # FIXME
+IgnoreDirectoryMissingTrailingSlash: true # FIXME
+IgnoreDirs: [_print] # FIXME
+IgnoreEmptyHref: true # FIXME
+IgnoreInternalEmptyHash: true # FIXME
+IgnoreURLs: [http://localhost, https://https://github.com/kube-logging/kube-logging.github.io/new/*, _print/]

config/_default/config.toml

@@ -69,7 +69,7 @@ twitter = "calisti12"
   # Used in the "version-banner" partial to display a version number for the 
   # current doc set.
 
-  version = "4.4.0"
+  version = "4.5.0"
   version_menu = "Releases"
   version_menu_canonicallinks = true
   version_menu_pagelinks = true
@@ -169,9 +169,13 @@ twitter = "calisti12"
 #######################
 # Add your release versions here
 [[params.versions]]
-  version = "latest (4.4.0)"
+  version = "latest (4.5.0)"
   githubbranch = "master"
   url = ""
+[[params.versions]]
+  version = "4.4"
+  githubbranch = "release-4.4"
+  url = "/4.4/"
 [[params.versions]]
   version = "4.3"
   githubbranch = "release-4.3"
@@ -188,7 +192,7 @@ twitter = "calisti12"
 # Cascade version number to every doc page (needed to create sections for pagefind search)
 # Update this parameter when creating a new version
 [[cascade]]
-body_attribute = 'data-pagefind-filter="section:4.4"'
+body_attribute = 'data-pagefind-filter="section:4.5"'
 [cascade._target]
   path = '/docs/**'
 

content/docs/configuration/crds/extensions/eventtailer_types.md

@@ -8,41 +8,35 @@ generated_file: true
 
 EventTailerSpec defines the desired state of EventTailer
 
+### containerOverrides (*types.ContainerBase, optional) {#eventtailerspec-containeroverrides}
+
+Override container fields for the given statefulset 
+
+
 ### controlNamespace (string, required) {#eventtailerspec-controlnamespace}
 
 The resources of EventTailer will be placed into this namespace 
 
-Default: -
 
-### positionVolume (volume.KubernetesVolume, optional) {#eventtailerspec-positionvolume}
+### image (*tailer.ImageSpec, optional) {#eventtailerspec-image}
 
-Volume definition for tracking fluentbit file positions (optional) 
+Override image related fields for the given statefulset, highest precedence 
 
-Default: -
 
-### workloadMetaOverrides (*types.MetaBase, optional) {#eventtailerspec-workloadmetaoverrides}
+### positionVolume (volume.KubernetesVolume, optional) {#eventtailerspec-positionvolume}
 
-Override metadata of the created resources 
+Volume definition for tracking fluentbit file positions (optional) 
 
-Default: -
 
 ### workloadOverrides (*types.PodSpecBase, optional) {#eventtailerspec-workloadoverrides}
 
 Override podSpec fields for the given statefulset 
 
-Default: -
-
-### containerOverrides (*types.ContainerBase, optional) {#eventtailerspec-containeroverrides}
-
-Override container fields for the given statefulset 
 
-Default: -
-
-### image (*tailer.ImageSpec, optional) {#eventtailerspec-image}
+### workloadMetaOverrides (*types.MetaBase, optional) {#eventtailerspec-workloadmetaoverrides}
 
-Override image related fields for the given statefulset, highest precedence 
+Override metadata of the created resources 
 
-Default: -
 
 
 ## EventTailerStatus
@@ -56,19 +50,15 @@ EventTailer is the Schema for the eventtailers API
 
 ###  (metav1.TypeMeta, required) {#eventtailer-}
 
-Default: -
 
 ### metadata (metav1.ObjectMeta, optional) {#eventtailer-metadata}
 
-Default: -
 
 ### spec (EventTailerSpec, optional) {#eventtailer-spec}
 
-Default: -
 
 ### status (EventTailerStatus, optional) {#eventtailer-status}
 
-Default: -
 
 
 ## EventTailerList
@@ -77,14 +67,11 @@ EventTailerList contains a list of EventTailer
 
 ###  (metav1.TypeMeta, required) {#eventtailerlist-}
 
-Default: -
 
 ### metadata (metav1.ListMeta, optional) {#eventtailerlist-metadata}
 
-Default: -
 
 ### items ([]EventTailer, required) {#eventtailerlist-items}
 
-Default: -