Skip to content

Commit

Permalink
Change links to new location (#86)
Browse files Browse the repository at this point in the history
* Migrate to swiftlang repo

This fixes some 404s and dead links

* Delete .vscode/launch.json
  • Loading branch information
SwiftCoderJoe authored Jul 10, 2024
1 parent 8950edf commit 5761ba9
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ the behavior was correct in addition to your current version.

### Checklist
- [ ] If possible, I've reproduced the issue using the `main` branch of this package.
- [ ] This issue hasn't been addressed in an [existing GitHub issue](https://github.com/apple/swift-docc-plugin/issues).
- [ ] This issue hasn't been addressed in an [existing GitHub issue](https://github.com/swiftlang/swift-docc-plugin/issues).

### Expected behavior
Describe what you expected to happen.
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ contact_links:
url: https://forums.swift.org/c/development/swift-docc
about: Ask and answer questions about Swift-DocC
- name: Documentation
url: https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/
url: https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/
about: Read about how to use the Swift-DocC Plugin in your projects
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ from the community.
### Contributing Code and Documentation

Before contributing code or documentation to the Swift-DocC plugin,
we encourage you to first open a [GitHub issue](https://github.com/apple/swift-docc-plugin/issues/new/choose).
we encourage you to first open a [GitHub issue](https://github.com/swiftlang/swift-docc-plugin/issues/new/choose).
This will allow us to provide feedback on the proposed change.
However, this is not a requirement. If your contribution is small in scope,
feel free to open a PR without first creating an issue.
Expand Down Expand Up @@ -63,7 +63,7 @@ on [Swift.org](https://www.swift.org/download/#snapshots).
1. Checkout this repository using:

```bash
git clone [email protected]:apple/swift-docc-plugin.git
git clone [email protected]:swiftlang/swift-docc-plugin.git
```

2. Navigate to the root of your cloned repository with:
Expand Down
2 changes: 1 addition & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ let package = Package(
.plugin(name: "Swift-DocC Preview", targets: ["Swift-DocC Preview"]),
],
dependencies: [
.package(url: "https://github.com/apple/swift-docc-symbolkit", from: "1.0.0"),
.package(url: "https://github.com/swiftlang/swift-docc-symbolkit", from: "1.0.0"),
],
targets: [
.plugin(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ extension PackageManager {
case .skipSynthesizedSymbols:
symbolGraphOptions.includeSynthesized = false
default:
fatalError("error: unknown PluginFlag (\(customSymbolGraphOption.parsedValues.joined(separator: ", "))) detected in symbol graph generation - please create an issue at https://github.com/apple/swift-docc-plugin")
fatalError("error: unknown PluginFlag (\(customSymbolGraphOption.parsedValues.joined(separator: ", "))) detected in symbol graph generation - please create an issue at https://github.com/swiftlang/swift-docc-plugin")
}
}

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ documentation for SwiftPM libraries and executables.
## Usage

Please see
[the plugin's documentation](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/)
[the plugin's documentation](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/)
for more detailed usage instructions.

### Adding the Swift-DocC Plugin as a Dependency
Expand All @@ -18,7 +18,7 @@ let package = Package(
// name, platforms, products, etc.
dependencies: [
// other dependencies
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.1.0"),
.package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.1.0"),
],
targets: [
// targets
Expand Down Expand Up @@ -84,16 +84,16 @@ swift package --disable-sandbox preview-documentation --product OtherFramework

For details on how to best build documentation for hosting online and a specific
tutorial for publishing to GitHub Pages, please see
[the plugin's documentation](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/).
[the plugin's documentation](https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin/).

## Bug Reports and Feature Requests

### Submitting a Bug Report

The Swift-DocC plugin tracks all bug reports with
[GitHub Issues](https://github.com/apple/swift-docc-plugin/issues).
[GitHub Issues](https://github.com/swiftlang/swift-docc-plugin/issues).
When you submit a bug report we ask that you follow the
[provided template](https://github.com/apple/swift-docc-plugin/issues/new?template=BUG_REPORT.md)
[provided template](https://github.com/swiftlang/swift-docc-plugin/issues/new?template=BUG_REPORT.md)
and provide as many details as possible.

If you can confirm that the bug occurs when using the latest commit of the Swift-DocC plugin
Expand All @@ -102,7 +102,7 @@ from the `main` branch, that will help us track down the bug faster.
### Submitting a Feature Request

For feature requests, please feel free to file a
[GitHub issue](https://github.com/apple/swift-docc-plugin/issues/new?template=FEATURE_REQUEST.md)
[GitHub issue](https://github.com/swiftlang/swift-docc-plugin/issues/new?template=FEATURE_REQUEST.md)
or start a discussion on the [Swift Forums](https://forums.swift.org/c/development/swift-docc).

Don't hesitate to submit a feature request if you see a way
Expand Down
2 changes: 1 addition & 1 deletion Sources/SwiftDocCPluginDocumentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
user-facing documentation about using the Swift-DocC plugin from the command-line.

The documentation content in the `SwiftDocCPlugin.docc` catalog is published on GitHub pages
at https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin via the
at https://swiftlang.github.io/swift-docc-plugin/documentation/swiftdoccplugin via the
[`bin/update-gh-pages-documentation-site`](../../bin/update-gh-pages-documentation-site)
script in this repository.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ let package = Package(
// name, platforms, products, etc.
dependencies: [
// other dependencies
.package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
.package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0"),
],
targets: [
// targets
Expand Down
4 changes: 2 additions & 2 deletions bin/test
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ then
SWIFT_DOCC_RENDER_ARTIFACT_ROOT="$SWIFT_DOCC_PLUGIN_ROOT/swift-docc-render-artifact"
export DOCC_HTML_DIR="$SWIFT_DOCC_RENDER_ARTIFACT_ROOT/dist"

SWIFT_DOCC_REPO=${SWIFT_DOCC_REPO:="https://github.com/apple/swift-docc.git"}
SWIFT_DOCC_RENDER_ARTIFACT_REPO=${SWIFT_DOCC_RENDER_ARTIFACT_REPO:="https://github.com/apple/swift-docc-render-artifact.git"}
SWIFT_DOCC_REPO=${SWIFT_DOCC_REPO:="https://github.com/swiftlang/swift-docc.git"}
SWIFT_DOCC_RENDER_ARTIFACT_REPO=${SWIFT_DOCC_RENDER_ARTIFACT_REPO:="https://github.com/swiftlang/swift-docc-render-artifact.git"}

SWIFT_DOCC_BRANCH=${SWIFT_DOCC_BRANCH:="main"}
SWIFT_DOCC_RENDER_ARTIFACT_BRANCH=${SWIFT_DOCC_RENDER_ARTIFACT_BRANCH:="main"}
Expand Down

0 comments on commit 5761ba9

Please sign in to comment.