This repo contains the documentation and support content for the Concur API developer audience. This includes both internal and external developers.
Changes merged to the preview
repository (https://github.com/SAP-docs/preview.developer.concur.com) can be found here: https://preview.developer.concur.com/
Changes merged to the live
repository (https://github.com/SAP-docs/developer.concur.com) can be found here: https://developer.concur.com/
For contributions, it's required that you have a GitHub account. For more information, see Signing up for a new GitHub account in the GitHub documentation.
This repo only accepts contributions from SAP Concur employees who are responsible for the APIs documented here. If you have an issue with the documentation please follow the instructions in the Support section below.
The Concur Developer Website found within the /src
folder is organized into these areas:
_data Sidebars for navigation and various other YML files for the site.
_includes Base HTML for the site combined with Markdown at build time.
_layouts Specific HTML for the various types of resources, referenced with Jekyll front matter, combined with Markdown at build time.
_plugins Various Jekyll plugins used at build time.
_sass CSS styling for the site.
api-explorer OpenAPI documentation (aka 'Swagger') for some of the API endpoints.
api-guides Partner enablement resources showing how to combine various APIs for end-to-end solutions.
api-reference Specific API endpoint documentation.
assets Various site wide images.
manage-apps SAP Concur App Center partner marketing materials.
swagger-ui Supporting files for /api-explorer
tools-support Support resources for developers including release notes.
If you are an existing Concur partner and require support assistance, please open a partner support case here.
Within CircleCI:
- Environment is created.
- Source code for the site is cloned from GitHub.
- Installs the packages needed to build the site, primarily the Jekyll package -- see https://github.com/jekyll/jekyll.
- Builds the entire site according to
_config.yml
. This is mostly converting Markdown to HTML using Jekyll. - Archives the site.
If the site build is successful, within CircleCI:
- Environment is created.
- Generated static content is updated in gh-pages branch
- gh-pages branch is automatically re-published using GitHub Pages
Please refer to our Code of Conduct when contributing
Copyright 2021 SAP SE or an SAP affiliate company and SAP Concur API documentation contributors.
Please see our LICENSE for copyright and license information.
Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool (https://api.reuse.software/info/github.com/SAP-docs/preview.developer.concur.com)