Merge pull request #278 from candlepin/ojanus/links

Update links to point to candlepinproject.org
candlepin · Oct 23, 2023 · 13737a8 · 13737a8
2 parents e81de61 + 13d1b24
commit 13737a8
Show file tree

Hide file tree

Showing 18 changed files with 27 additions and 46 deletions.
diff --git a/.github/workflows/jekyll.yml b/.github/workflows/jekyll.yml
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-![Build Status](https://github.com/candlepin/candlepin.github.io/actions/workflows/jekyll.yml/badge.svg?branch=main)
+![Build Status](https://github.com/candlepin/candlepin.github.io/actions/workflows/deploy.yml/badge.svg?branch=main)
 
 # Getting Started
 ## Container Development (Easy Mode)

diff --git a/_config.yml b/_config.yml
@@ -18,6 +18,7 @@ exclude:
   - 'README.md'
   - 'config.ru'
   - 'Dockerfile'
+  - 'local_test.sh'
 
 projects_dir: 'docs'
 

diff --git a/docs/candlepin/documentation_authoring.md b/docs/candlepin/documentation_authoring.md
@@ -1,11 +1,18 @@
 ---
 title: Documentation
 ---
-# Candlepin Documentation
-Candlepin documentation is split into three major pieces. A Jekyll based web site [https://candlepin.github.io/](https://candlepin.github.io/), JavaDoc that is currently only in the source code and REST API that is being hosted on [https://candlepin.github.io/](https://candlepin.github.io/) and is auto-generated by so called API Crawler (Java project in server's code base)
 
-When you need to submit new documentation, you should clone sources of the site from  [Github repo](https://github.com/candlepin/candlepin.github.io) and issue a Pull Request. After your pull request is merged, the new site content is automatically published to [https://candlepin.github.io/](https://candlepin.github.io/)
+# Candlepin Documentation
 
-While preparing the Pull Request with changes to the documentation you should use local Jekyll instance to see your changes to the documentation. See README.md file in site's sources.
+Candlepin documentation is split into three major pieces. A Jekyll based web
+site [https://candlepinproject.org/](https://candlepinproject.org/), JavaDoc that is currently only in the
+source code and REST API that is being hosted on [https://candlepinproject.org/](https://www.candlepinproject.org/docs/candlepin/swaggerapi.html)
+and is auto-generated by OpenAPI from our API spec.
 
+When you need to submit new documentation, you should clone sources of the site
+from  [Github repo](https://github.com/candlepin/candlepin.github.io) and issue a Pull Request. After your
+pull request is merged, the new site content is automatically published
+to [https://candlepin.github.io/](https://candlepin.github.io/)
 
+While preparing the Pull Request with changes to the documentation you should use local Jekyll instance to see
+your changes to the documentation. See README.md file in site's sources.
diff --git a/docs/subscription-manager/dbus_objects.md b/docs/subscription-manager/dbus_objects.md
@@ -417,7 +417,7 @@ creates.
   be different on other versions of candlepin server. JSON document is
   generated by this REST API endpoint:
 
-  https://www.candlepin.github.io/swagger/?url=candlepin/swagger-3.1.16.json#!/consumers/create
+  https://www.candlepinproject.org/swagger/?url=candlepin/swagger-3.1.16.json#!/consumers/create
 
 * `RegisterWithActivationKeys(string, array(strings), dictionary(string,
   variant), dictionary(string, variant), string)`: Register a system using one or more

diff --git a/swagger/candlepin/swagger-2.0.13.json b/swagger/candlepin/swagger-2.0.13.json
diff --git a/swagger/candlepin/swagger-2.0.21.json b/swagger/candlepin/swagger-2.0.21.json
diff --git a/swagger/candlepin/swagger-2.0.25.json b/swagger/candlepin/swagger-2.0.25.json
diff --git a/swagger/candlepin/swagger-2.0.40.json b/swagger/candlepin/swagger-2.0.40.json
diff --git a/swagger/candlepin/swagger-2.1.25.json b/swagger/candlepin/swagger-2.1.25.json
diff --git a/swagger/candlepin/swagger-2.1.3.json b/swagger/candlepin/swagger-2.1.3.json
diff --git a/swagger/candlepin/swagger-2.2.0.json b/swagger/candlepin/swagger-2.2.0.json
diff --git a/swagger/candlepin/swagger-2.3.10.json b/swagger/candlepin/swagger-2.3.10.json
diff --git a/swagger/candlepin/swagger-2.4.8.json b/swagger/candlepin/swagger-2.4.8.json
diff --git a/swagger/candlepin/swagger-2.5.7.json b/swagger/candlepin/swagger-2.5.7.json
diff --git a/swagger/candlepin/swagger-2.9.17.json b/swagger/candlepin/swagger-2.9.17.json
diff --git a/swagger/candlepin/swagger-3.1.16.json b/swagger/candlepin/swagger-3.1.16.json
diff --git a/swagger/candlepin/swagger-4.0.18.json b/swagger/candlepin/swagger-4.0.18.json