Merge pull request #1706 from bettio/move-documentation-to-doc-domain

Move documentation to doc.atomvm.org

These changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).

SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later

Author: bettio

.github/workflows/publish-docs.yaml

@@ -94,8 +94,8 @@ jobs:
       - uses: actions/checkout@v4
         id: checkout-production
         with:
-          repository: atomvm/atomvm_www
-          ref: Production
+          repository: atomvm/doc.atomvm.org
+          ref: main
           path: /home/runner/work/AtomVM/AtomVM/www
 
       - name: Track all branches
@@ -115,21 +115,20 @@ jobs:
           cmake ..
           cd doc
           make GitHub_CI_Publish_Docs
-          rm -frv "/__w/AtomVM/AtomVM/www/doc/${{ github.ref_name }}"
-          cp -av html "/__w/AtomVM/AtomVM/www/doc/${{ github.ref_name }}"
+          rm -frv "/__w/AtomVM/AtomVM/www/${{ github.ref_name }}"
+          cp -av html "/__w/AtomVM/AtomVM/www/${{ github.ref_name }}"
       - name: Commit files
         id: commit_files
         if: github.repository == 'atomvm/AtomVM'
         working-directory: /home/runner/work/AtomVM/AtomVM/www
         run: |
           git config --local user.email "atomvm-doc-bot@users.noreply.github.com"
           git config --local user.name "AtomVM Doc Bot"
-          ls -la doc/
-          git status "doc/${{ github.ref_name }}"
-          git add "doc/${{ github.ref_name }}"
+          git status "${{ github.ref_name }}"
+          git add "${{ github.ref_name }}"
           git add .
-          git diff --exit-code Production || echo "Going to commit"
-          git diff --exit-code Production || git commit -m "Update Documentation for ${{ github.ref_name }}"
+          git diff --exit-code main || echo "Going to commit"
+          git diff --exit-code main || git commit -m "Update Documentation for ${{ github.ref_name }}"
           git log -1
       - name: Push changes
         if: github.repository == 'atomvm/AtomVM'
@@ -142,7 +141,7 @@ jobs:
           echo "github.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl" > ~/.ssh/known_hosts
           echo "github.com ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBEmKSENjQEezOmxkZMy7opKgwFB9nkt5YRrYMjNuG5N87uRgg6CLrbo5wAdT/y6v0mKV0U2w0WZ2YB/++Tpockg=" >> ~/.ssh/known_hosts
           echo "github.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCj7ndNxQowgcQnjshcLrqPEiiphnt+VTTvDP6mHBL9j1aNUkY4Ue1gvwnGLVlOhGeYrnZaMgRK6+PKCUXaDbC7qtbW8gIkhL7aGCsOr/C56SJMy/BCZfxd1nWzAOxSDPgVsmerOBYfNqltV9/hWCqBywINIR+5dIg6JTJ72pcEpEjcYgXkE2YEFXV1JHnsKgbLWNlhScqb2UmyRkQyytRLtL+38TGxkxCflmO+5Z8CSSNY7GidjMIZ7Q4zMjA2n1nGrlTDkzwDCsw+wqFPGQA179cnfGWOWRVruj16z6XyvxvjJwbz0wQZ75XK5tKSb7FNyeIEs4TT4jk+S4dhPeAUC5y+bDYirYgM4GC7uEnztnZyaVWQ7B381AK4Qdrwt51ZqExKbQpTUNn+EjqoTwvqNj4kqx5QUCI0ThS/YkOxJCXmPUWZbhjpCg56i+2aB6CmK2JGhn57K5mj0MNdBXA4/WnwH6XoPWJzK5Nyu2zB3nAZp+S5hpQs+p1vN1/wsjk=" >> ~/.ssh/known_hosts
-          git remote add push_dest "git@github.com:atomvm/atomvm_www.git"
+          git remote add push_dest "git@github.com:atomvm/doc.atomvm.org.git"
           git fetch push_dest
-          git diff --exit-code push_dest/Production || echo "Going to push"
-          git diff --exit-code push_dest/Production || git push --set-upstream push_dest Production
+          git diff --exit-code push_dest/main || echo "Going to push"
+          git diff --exit-code push_dest/main || git push --set-upstream push_dest main

doc/conf.py.in

@@ -148,7 +148,9 @@ html_css_files = [
 
 html_favicon = '@CMAKE_CURRENT_SOURCE_DIR@/src/_static/favicon/favicon.ico'
 
-html_baseurl = 'https://atomvm.net/doc'
+# html_baseurl is used for the Canonical Link Relation
+# See also https://datatracker.ietf.org/doc/html/rfc6596.html
+html_baseurl = 'https://doc.atomvm.org/release-0.6/'
 
 ############################
 # SETUP THE RTD LOWER-LEFT #
@@ -158,7 +160,7 @@ try:
 except NameError:
    html_context = dict()
 
-html_baseurl = 'https://atomvm.net/doc'
+html_baseurl = 'https://doc.atomvm.org/release-0.6/'
 
 html_context['display_lower_left'] = 'True'
 

doc/edoc/gendoc.erl.in

@@ -36,7 +36,9 @@ main([LibraryName, SrcDir, TgtDir]) ->
             {doclet, edown_doclet},
             {source_path, ["src"]},
             {library, LibraryName},
-            {LibraryName, "https://atomvm.net/doc/apidocs/erlang/" ++ LibraryName},
+            % This is used as Canonical Link Relation
+            % See also: https://datatracker.ietf.org/doc/html/rfc6596.html
+            {LibraryName, "https://doc.atomvm.org/release-0.6/apidocs/erlang/" ++ LibraryName},
             {stylesheet, ""},
             {image, ""},
             {dir, TgtDir}