Comments (6)
Hi Dave, I would like to look into this issue. Can you please tell how are the documents are made currently?
from ziti-sdk-swift.
Great! The docs are currently built using jazzy
in a GitHub action, then uploaded as artifacts on the action. Have a look at
ziti-sdk-swift/.github/workflows/CI.yml
Line 83 in 49e7bf4
Don't worry about the Docusaurus note - just getting them into this repo's gihub-pages is enough. I'll probably need to configure the repo for you, How I do that will depend on the way you implement (repo asks to choose between deploying from a branch or via GitHub action - we'd want to automatically deploy thru a GitHub Action either way)
from ziti-sdk-swift.
Hey Dave,
I saw the yml
file and it looks like the docs are zipped into a ziti-sdk-swift-docs.tgz
file.
Please correct me if I am wrong but then we only need to probably unzip the file and I am assuming it contains some kind of index.html
file which can then be deployed to GitHub pages. In that case, can I get the tgz
file? I will probably try to deploy it to my personal GitHub page link (and they use similar steps in this repo?) or if you have an existing pipeline that does the deployment of such kinds of docs then maybe we can use that directly?
from ziti-sdk-swift.
Looks like you are on the right track. That tgz
is uploaded as on artifact for each release, latest here: https://github.com/openziti/ziti-sdk-swift/releases/latest. I'd go about this the same way you suggest, mainly because I'd first need to learn how to do the deploy. Currently, the Draft-Release step is the place where we move the artifact to the release. We have a different pipeline (in ziti-docs
) that moves them to here that we'll update once this issue is completed
from ziti-sdk-swift.
Hi Dave, I am a bit confused about the resolution of the issue. The docs are already deployed fine, what are we supposed to change here?
from ziti-sdk-swift.
It's really close - the docs are all generated, but we want them deployed to https://openziti.github.io/ziti-sdk-swift/ (the "GitHub Pages" link for this repo) instead of just attached as an artifact to the Release.
I haven't done much research on how to do this, but it will likely entail creating a new action that runs after the doc zip is uploaded to the Release that deploys to this repo's GitHub Pages.
from ziti-sdk-swift.
Related Issues (15)
- Jazzy documentation update needed
- NetFoundry info embedded in project
- [email protected] "hardcoded", I don't think I can "Build Manually" HOT 1
- README Artifactory reference is obsolete
- XCFramework, binary distribution as Swift Package
- Add sample with acync/await REST calls HOT 1
- Whether socket interception is supported HOT 4
- Deprecate CZiti-iOS.podspec and CZiti-macOS.podspec in favor of CZiti.podspec HOT 1
- some error after import CZiti.xcframework HOT 2
- How to change the TLS handshake signature algorithm? HOT 2
- TLS handshake error on iPhone device HOT 13
- Ziti Mobile Edge crashes HOT 3
- Whether to change hosts HOT 1
- initCallback is not called when first Ziti event is received
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ziti-sdk-swift.