Update Documentation For Private Github Pages

swiftlang / swift-docc-plugin

Swift Package Manager command plugin for Swift-DocC

https://swiftpackageindex.com/swiftlang/swift-docc-plugin/documentation/swiftdoccplugin

Apache License 2.0

317 stars 54 forks source link

Update Documentation For Private Github Pages #15

Closed denil-ct closed 2 years ago

denil-ct commented 2 years ago

Bug/issue #, if applicable: https://forums.swift.org/t/docc-for-private-github-repos/55770/2

Summary

Added documentation for github private pages . For private repos, hosting-base-path is not needed, as each repo is served from its own subdomain. Also the url format for such pages is also different.

Dependencies

Not Applicable

Testing

Not Applicable

Checklist

[ ] Added tests
[ ] Ran the ./bin/test script and it succeeded
[x] Updated documentation if necessary

denil-ct commented 2 years ago

@swift-ci please test

denil-ct commented 2 years ago

@ethan-kusters Could you please review?

denil-ct commented 2 years ago

@ethan-kusters done, check it out

denil-ct commented 2 years ago

@ethan-kusters have added a few replies for some things. Other stuff related to the condensing I will take in, no problems.

ethan-kusters commented 2 years ago

@swift-ci please test

denil-ct commented 2 years ago

@ethan-kusters should I squash everything and make it to a single commit?

denil-ct commented 2 years ago

Awesome, nice working with you

ethan-kusters commented 2 years ago

@ethan-kusters should I squash everything and make it to a single commit?

No worries- we can do a "Squash and merge" via the GitHub UI when we merge. Are you able to do that (once CI finishes)? I'm not sure how the permissions work exactly. If not, I'm happy to do it on your behalf.

denil-ct commented 2 years ago

The checks will probably be reset when I push again, you can squash while merging.