diff --git a/README.md b/README.md index 2f210a6..2dde176 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,13 @@ -# XPP-api-docs +# XPP API Docs ## What is it? -This the main repository for the XPP Public API documentation. +This the main repository for XPP RESTful API’s documentation. ## Can I contribute? Anyone is welcome to contribute to the public XPP API documentation by making a pull request into the master repository. - -The documentation is split into the following sections: -- Articles - - This section hosts a series of usefull article on: - - how to get started with writing plug-ins for XPP - - how to best use the public APIs - - how to troubleshoot common issues -- API Concepts - - This section hosts the main guidelines on using the Public API along with the API References - ### Getting started with your contribution The documentation is built using a static documentation generator called [DocFX](https://dotnet.github.io/docfx/). The documentation content is saved in *Markdown* files and then built into a website using [DocFX](https://dotnet.github.io/docfx/). The table of content is saved into separate *toc.yml* files. @@ -29,7 +19,7 @@ In order for you to make a contribution directly please follow the next steps: - You can use tools such as *Notepad++* or *Visual Studio Code* to edit the content - Create a Pull Request with your changes. - This pull request will be reviewed for correctness by one of our technical writers -- Once your pull request has been approved and committed into the *main* branch, an automatic pipeline will be triggered which will push your changes to the [live documentation site](https://rws.github.io/studio-api-docs/index.html) +- Once your pull request has been approved and committed into the *main* branch, an automatic pipeline will be triggered which will push your changes to the [live documentation site](https://rws.github.io/xpp-api-docs/index.html) - if you wish to test your changes locally you can follow the [DOCFX Installation guideline](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html) and [build the entire solution locally](https://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_create_a_docfx_project.html) - Our documentation automatically fills in the product name and other details so you don't have to make the changes manually if we decide to update the product name. Use the '' construct to tell our documentation engine to fill in the info for you. Here are the constructs available at this point: diff --git a/api/.gitignore b/api/.gitignore deleted file mode 100644 index e8079a3..0000000 --- a/api/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -############### -# temp file # -############### -*.yml -.manifest diff --git a/api/index.md b/api/index.md deleted file mode 100644 index 78dc9c0..0000000 --- a/api/index.md +++ /dev/null @@ -1,2 +0,0 @@ -# PLACEHOLDER -TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! diff --git a/apiconcepts/overview.md b/apiconcepts/overview.md deleted file mode 100644 index 116803a..0000000 --- a/apiconcepts/overview.md +++ /dev/null @@ -1,16 +0,0 @@ -# XPP RESTful Web Services - -Welcome! This site is for developers building tools with XPP RESTful Web Services. -Here you will find installation guides, configuration instructions, usage examples, and best practices for integrating and extending the capabilities of XPP through its RESTful APIs. - -## Installation - -For complete installation and setup information, please refer to the **[XPP Technical Documentation](https://docs.rws.com/en-US/xpp-restful-web-services-1-6-1248383/welcome-to-the-xpp-restful-web-services-documentation-411242)** on the official RWS documentation portal. - -## API Documentation - -The documentation for all API calls is available in **[this human-readable HTML web app](documentation/index.html)** that provides a structured overview of all endpoints, request/response formats, supported parameters, and example payloads. - -## OpenAPI Specification - -The documentation above is derived from **[this JSON file](documentation/xpp-rest.json)** that conforms to version 3.1 of the **[OpenAPI Specification](https://spec.openapis.org/oas/v3.1.0.html)**. diff --git a/apiconcepts/toc.yml b/apiconcepts/toc.yml deleted file mode 100644 index 4e54b9d..0000000 --- a/apiconcepts/toc.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: Overview - href: overview.md \ No newline at end of file diff --git a/articles/intro.md b/articles/intro.md deleted file mode 100644 index a273fd5..0000000 --- a/articles/intro.md +++ /dev/null @@ -1,7 +0,0 @@ -# Welcome to the XPP API documentation # - -Here you’ll find all the information you need to get started developing with the XPP API. - -Should you have any ideas as to how we can improve this documentation, any new topics you think we should include or hints and tips you would like to share with the developer community, please let us know via your account manager. - -Good luck and happy developing! diff --git a/articles/toc.yml b/articles/toc.yml deleted file mode 100644 index ff89ef1..0000000 --- a/articles/toc.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: Introduction - href: intro.md diff --git a/docfx.json b/docfx.json index feac0c2..0feb00e 100644 --- a/docfx.json +++ b/docfx.json @@ -3,21 +3,8 @@ "content": [ { "files": [ - "api/**.yml" - ] - }, - { - "files": [ - "articles/**.md", - "articles/**/toc.yml", "toc.yml", - "*.md" - ] - }, - { - "files": [ - "apiconcepts/**.md", - "apiconcepts/toc.yml" + "index.md" ] } ], @@ -25,18 +12,15 @@ { "files": [ "**/images/**", - "**/*.json", - "**/*.html", - "**/*.js", - "**/*.css" + "docs/*.json", + "docs/*.html", + "docs/*.js", + "docs/*.css" ] } ], "overwrite": [ { - "files": [ - "api/**.md" - ], "exclude": [ "obj/**", "_site/**" diff --git a/apiconcepts/documentation/LICENSE b/docs/LICENSE similarity index 100% rename from apiconcepts/documentation/LICENSE rename to docs/LICENSE diff --git a/apiconcepts/documentation/NOTICE b/docs/NOTICE similarity index 100% rename from apiconcepts/documentation/NOTICE rename to docs/NOTICE diff --git a/apiconcepts/documentation/index.css b/docs/index.css similarity index 100% rename from apiconcepts/documentation/index.css rename to docs/index.css diff --git a/apiconcepts/documentation/index.html b/docs/index.html similarity index 100% rename from apiconcepts/documentation/index.html rename to docs/index.html diff --git a/apiconcepts/documentation/swagger-initializer.js b/docs/swagger-initializer.js similarity index 100% rename from apiconcepts/documentation/swagger-initializer.js rename to docs/swagger-initializer.js diff --git a/apiconcepts/documentation/swagger-ui-bundle.js b/docs/swagger-ui-bundle.js similarity index 100% rename from apiconcepts/documentation/swagger-ui-bundle.js rename to docs/swagger-ui-bundle.js diff --git a/apiconcepts/documentation/swagger-ui-standalone-preset.js b/docs/swagger-ui-standalone-preset.js similarity index 100% rename from apiconcepts/documentation/swagger-ui-standalone-preset.js rename to docs/swagger-ui-standalone-preset.js diff --git a/apiconcepts/documentation/swagger-ui.css b/docs/swagger-ui.css similarity index 100% rename from apiconcepts/documentation/swagger-ui.css rename to docs/swagger-ui.css diff --git a/apiconcepts/documentation/xpp-rest.css b/docs/xpp-rest.css similarity index 100% rename from apiconcepts/documentation/xpp-rest.css rename to docs/xpp-rest.css diff --git a/apiconcepts/documentation/xpp-rest.js b/docs/xpp-rest.js similarity index 100% rename from apiconcepts/documentation/xpp-rest.js rename to docs/xpp-rest.js diff --git a/apiconcepts/documentation/xpp-rest.json b/docs/xpp-rest.json similarity index 100% rename from apiconcepts/documentation/xpp-rest.json rename to docs/xpp-rest.json diff --git a/index.md b/index.md index a90a12f..5112b16 100644 --- a/index.md +++ b/index.md @@ -1,9 +1,16 @@ -# Access the XPP APIs +# XPP RESTful Web Services -## [Learn more about XPP APIs](apiconcepts/overview.md) -Learn more about the APIs and what you can achieve with them. +Welcome! This site is for developers building tools with XPP RESTful Web Services. +Here you will find installation guides, configuration instructions, usage examples, and best practices for integrating and extending the capabilities of XPP through its RESTful APIs. -## [Articles](articles/intro.md) -Read articles on how to get more out of XPP. +## Installation -RWS +For complete installation and setup information, please refer to the **[XPP Technical Documentation](https://docs.rws.com/en-US/xpp-restful-web-services-1-6-1248383/welcome-to-the-xpp-restful-web-services-documentation-411242)** on the official RWS documentation portal. + +## API Documentation + +The documentation for all API calls is available in **this human-readable HTML web app** that provides a structured overview of all endpoints, request/response formats, supported parameters, and example payloads. + +## OpenAPI Specification + +The documentation above is derived from **this JSON file** that conforms to version 3.1 of the **[OpenAPI Specification](https://spec.openapis.org/oas/v3.1.0.html)**. diff --git a/toc.yml b/toc.yml index 1b0d7fb..a7c4b6c 100644 --- a/toc.yml +++ b/toc.yml @@ -1,6 +1,2 @@ - name: XPP - href: index.md -- name: Articles - href: articles/ -- name: API - href: apiconcepts/ + href: index.md \ No newline at end of file