Migrate to the Aparoksha gitea instance

.gitea/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,4 @@
 ## Steps
-- [ ] Add your name or username and a link to your GitHub profile into the [Contributors.md][1] file.
 - [ ] Build the project on your machine. If it does not compile, fix the errors.
 - [ ] Describe the purpose and approach of your pull request below.
 - [ ] Submit the pull request. Thank you very much for your contribution!
@@ -10,5 +9,3 @@ _If there is a related issue, add the link._
 
 ## Approach
 _Describe how this pull request solves the problem or adds the feature._
-
-[1]:	/Contributors.md

.gitea/workflows/docs.yml

@@ -4,21 +4,9 @@ on:
   push:
     branches: ["main"]
 
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-concurrency:
-  group: "pages"
-  cancel-in-progress: true
-
 jobs:
-  Deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: macos-15
+  publish:
+    runs-on: david-macbook
     steps:
       - uses: actions/checkout@v4
       - name: Build Docs
@@ -31,15 +19,16 @@ jobs:
           xcrun docc process-archive transform-for-static-hosting \
             "$PWD/.derivedData/Build/Products/Debug/LevenshteinTransformations.doccarchive" \
             --output-path "docs" \
-            --hosting-base-path "LevenshteinTransformations"
+            --hosting-base-path "/"
       - name: Modify Docs
         run: |
-          echo "<script>window.location.href += \"/documentation/levenshteintransformations\"</script>" > docs/index.html;
+          echo "<script>window.location.href += \"/documentation/levenshteintransformations\"</script><p>Please enable JavaScript to view the documentation <a href='/documentation/levenshteintransformations'>here</a>.</p>" > docs/index.html;
           sed -i '' 's/,2px/,10px/g' docs/css/index.*.css
-      - name: Upload Artifact
-        uses: actions/upload-pages-artifact@v3
+      - name: Upload
+        uses: wangyucode/sftp-upload-action@v2.0.2
         with:
-          path: 'docs'
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
+          host: 'volans.uberspace.de'
+          username: 'akforum'
+          password: ${{ secrets.password }}
+          localDir: 'docs'
+          remoteDir: '/var/www/virtual/akforum/levenshtein-transformations.aparoksha.dev/'

.gitea/workflows/swiftlint.yml

@@ -3,17 +3,17 @@ name: SwiftLint
 on:
   push:
     paths:
-      - '.github/workflows/swiftlint.yml'
+      - '.gitea/workflows/swiftlint.yml'
       - '.swiftlint.yml'
       - '**/*.swift'
   pull_request:
     paths:
-      - '.github/workflows/swiftlint.yml'
+      - '.gitea/workflows/swiftlint.yml'
       - '.swiftlint.yml'
       - '**/*.swift'
   workflow_dispatch:
     paths:
-      - '.github/workflows/swiftlint.yml'
+      - '.gitea/workflows/swiftlint.yml'
       - '.swiftlint.yml'
       - '**/*.swift'
 
@@ -21,7 +21,7 @@ jobs:
   SwiftLint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
       - name: SwiftLint
         uses: norio-nomura/action-swiftlint@3.2.1
         with:

.swiftlint.yml

@@ -94,12 +94,7 @@ disabled_rules:
 
 # Custom Rules
 custom_rules:
-    github_issue:
-        name: 'GitHub Issue'
-        regex: '//.(TODO|FIXME):.(?!.*(https://github\.com/david-swift/LevenshteinTransformations/issues/\d))'
-        message: 'The related GitHub issue must be included in a TODO or FIXME.'
-        severity: warning
-    
+
     fatal_error:
         name: 'Fatal Error'
         regex: 'fatalError.*\(.*\)'

CONTRIBUTING.md

@@ -1,35 +0,0 @@
-# Contributing
-
-Thank you very much for taking the time for contributing to this project. 
-
-## Report a Bug
-Just open a new issue on GitHub and describe the bug. It helps if your description is detailed. Thank you very much for your contribution!
-
-## Suggest a New Feature
-Just open a new issue on GitHub and describe the idea. Thank you very much for your contribution!
-
-## Pull Requests
-I am happy for every pull request, you do not have to follow these guidelines. However, it might help you to understand the project structure and make it easier for me to merge your pull request. Thank you very much for your contribution!
-
-### 1. Fork & Clone this Project
-Start by clicking on the `Fork` button at the top of the page. Then, clone this repository to your computer. 
-
-### 2. Open the Project
-Open the project folder in GNOME Builder, Xcode or another IDE.
-
-### 3. Understand the Project Structure
-- The `README.md` file contains a description of the app or package.
-- The `Contributors.md` file contains the names or usernames of all the contributors with a link to their GitHub profile.
-- The `LICENSE.md` contains a GPL-3.0 license.
-- `CONTRIBUTING.md` is this file.
-- Directory `data` that contains the icons.
-- `Sources` contains the source code of the project.
-
-### 4. Edit the Code
-Edit the code. If you add a new type, add documentation in the code.
-
-### 5. Commit to the Fork
-Commit and push the fork.
-
-### 6. Pull Request
-Open GitHub to submit a pull request. Thank you very much for your contribution!

README.md

@@ -4,12 +4,12 @@
 </p>
 
 <p align="center">
-  <a href="https://david-swift.github.io/LevenshteinTransformations">
+  <a href="https://levenshtein-transformations.aparoksha.dev/">
   Documentation
   </a>
   ·
-  <a href="https://github.com/david-swift/LevenshteinTransformations">
-  GitHub
+  <a href="https://git.aparoksha.dev/aparoksha/levenshtein-transformations">
+  Code
   </a>
 </p>
 
@@ -27,15 +27,16 @@ Transform an array into any other array of the same type, or a string into any o
 2. Open the `Package.swift` file.
 3. Into the `Package` initializer, under `dependencies`, paste:
 ```swift
-.package(url: "https://github.com/david-swift/LevenshteinTransformations", from: "0.1.0")   
+.package(url: "https://git.aparoksha.dev/aparoksha/levenshtein-transformations", from: "0.1.0")   
 ```
 
 ## Usage
 
-Read the [Getting Started](https://david-swift.github.io/LevenshteinTransformations/documentation/levenshteintransformations/gettingstarted/#Usage) article to learn how to use this package.
+Read the [Getting Started](https://levenshtein-transformations.aparoksha.dev/documentation/levenshteintransformations/gettingstarted/#Usage) article to learn how to use this package.
 
 ## Thanks
 
+- [DocC](https://github.com/apple/swift-docc) used for the documentation
 - [SwiftLint](https://github.com/realm/SwiftLint) for checking whether code style conventions are violated
 - The programming language [Swift](https://github.com/apple/swift)
 

Sources/LevenshteinTransformations/LevenshteinTransformations.docc/GettingStarted.md

@@ -8,7 +8,7 @@ Learn how to use _Levenshtein Transformations_.
 2. Open the `Package.swift` file.
 3. Into the `Package` initializer, under `dependencies`, paste:
 ```swift
-.package(url: "https://github.com/david-swift/LevenshteinTransformations", from: "0.1.0")   
+.package(url: "https://git.aparoksha.dev/aparoksha/levenshtein-transformations", from: "0.1.0")   
 ```
 
 ## Usage
@@ -69,6 +69,6 @@ The same functions are available for arrays with identifiable elements, but they
 - ``Swift/Array/identifiableTransform(to:functions:)``
 
 ## Development
-_Levenshtein Transformations_ is an open source project. Visit the [GitHub repository][1] for bug reports, feature requests, pull requests and more information.
+_Levenshtein Transformations_ is an open source project. Visit the [Git repository][1] for bug reports, feature requests, pull requests and more information.
 
-[1]:    https://github.com/david-swift/LevenshteinTransformations
+[1]:    https://git.aparoksha.dev/aparoksha/levenshtein-transformations