Skip to content
This repository was archived by the owner on Oct 5, 2021. It is now read-only.

docs: improve readme #18

Open
schmelto wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve readme #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 9 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# SAP Concur Developer Center (Source)

[![REUSE status](https://api.reuse.software/badge/github.com/sap-docs/developer.concur.com)](https://api.reuse.software/info/github.com/sap-docs/developer.concur.com)
Expand Down Expand Up @@ -37,31 +36,28 @@ If you are an existing Concur partner and require support assistance, please ope
Within CircleCI:

1. Environment is created.
1. Source code for the site is cloned from GitHub.
2. Source code for the site is cloned from GitHub.
1. Installs the packages needed to build the site, primarily the Jekyll package -- see https://github.com/jekyll/jekyll. and Slate package --see https://github.com/slatedocs/slate
1. Builds the entire site according to .circle/_config.yml file, as well as the 'config.yml' file for Jekyll at the root of this directory. This is mostly converting Markdown to HTML using Jekyll.
1. Archives the site.
3. Builds the entire site according to .circle/_config.yml file, as well as the 'config.yml' file for Jekyll at the root of this directory. This is mostly converting Markdown to HTML using Jekyll.
4. Archives the site.

# Site Deploy

If the site build is successful, within CircleCI:

1. Environment is created.
1. Workspace is created.
1. Entire site is deployed to a Github Pages branch, from which the site is then rendered.

2. Workspace is created.
3. Entire site is deployed to a Github Pages branch, from which the site is then rendered.

## Dependencies:

1. Jekyll: https://jekyllrb.com/docs/ (For main site)

2. Slate: https://github.com/slatedocs/slate (For API Exploerer and API Reference new UIs)



## To Preview the new API Explorer or API Reference sites from Visual Studio Code:

1. Clone the repository to your machine: `git clone https://github.com/sap-staging/developer.concur.com.git` or using Github Desktop (Green Code tab above > Open With Github Desktop)
1. Clone the repository to your machine: `git clone https://github.com/sap-staging/developer.concur.com.git` or using Github Desktop (Green Code tab above > Open With Github Desktop).

2. Install the VS Code **Go Live** Extension:
- Click on the 6th extension from the top left list of icons
Expand All @@ -73,9 +69,9 @@ If the site build is successful, within CircleCI:

4. Click the **Go Live** button at the bottom right of the VS Code window.

5. VS Code will open a new window rendering the site (typically on localhost:5500)
5. VS Code will open a new window rendering the site (typically on `localhost:5500`).

**Note:** This will allow you to preview the site only, but not to view updated changes you've made to API Explorer or API Reference files
**Note:** This will allow you to preview the site only, but not to view updated changes you've made to API Explorer or API Reference files.

To view the changes you've made to **API Reference** files, you will need to run Middleman on your VS Code Terminal or your CLI by entering the following commands:

Expand All @@ -91,22 +87,18 @@ You may also run the following commands:

From there you can simply click on the **Go Live** button in VS Code to view your updated changes.


**Note:** Updates to API Explorer files will follow their normal process as before, by updating the Swagger files in the `src` folder as mentioned in the steps below.



## To make changes to Swagger files (or other files) on your local machine using the CLI:

1. Clone the repository to your machine: `git clone https://github.com/sap-staging/developer.concur.com.git`
2. Using the editor of your choice, make changes to any files under the `src` folder. i.e. `sap-staging/developer.concur.com/src/api-explorer/v3-0/<filename>`


## To view changes on your local machine:

1. Change directories in your CLI to the `developer.concur.com` folder: `cd sap-staging/developer.concur.com`
2. Run the following commands: 1. `bundle install` (this only needs to be done one time) 2. `bundle exec jekyll serve` (each time)
4. Site can be viewed at `localhost:4000`
3. Site can be viewed at `localhost:4000`


## (New Change) To make changes specifically to files within API Reference:
Expand All @@ -123,17 +115,3 @@ From there you can simply click on the **Go Live** button in VS Code to view you
2. Run the following commands: 1. `bundle install`(this only needs to be done one time) 2. `bundle exec middleman server` (each time)

3. Changes can be viewed at `localhost:4567`