Skip to content

Commit 1e373cb

Browse files
sameeragunarathnesameeragunarathne
authored
Merge pull request #54 from sameeragunarathne/docusourus-migration
Fix issues with the document site link and minor issues
2 parents d25f345 + 61f1c52 commit 1e373cb

9 files changed

Lines changed: 138 additions & 45 deletions

File tree

‎.github/workflows/publish_docs.yaml‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ on:
66
- main
77
workflow_dispatch:
88

9-
permissions:
10-
contents: write
11-
129
jobs:
1310
release-wso2-open-healthcare-docs:
1411
runs-on: ubuntu-latest
@@ -34,7 +31,7 @@ jobs:
3431
run: npm run build
3532
working-directory: en
3633
env:
37-
BASE_URL: /${{ github.event.repository.name }}/
34+
BASE_URL: /open-healthcare-docs/
3835

3936
- name: Deploy to GitHub Pages
4037
uses: peaceiris/actions-gh-pages@v4

‎en/docs/install-and-setup/deploy-docker.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ You may map other container service ports, which have been exposed to Docker hos
8080
- To access the management console, use the docker host IP and port 9443.
8181
+ `https://<DOCKER_HOST>:9443/carbon`
8282

83-
> In here, <DOCKER_HOST> refers to hostname or IP of the host machine on top of which containers are spawned.
83+
> In here, `<DOCKER_HOST>` refers to hostname or IP of the host machine on top of which containers are spawned.

‎en/docs/secure-health-apis/guides/configure-smart-on-fhir.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In this example, we will walk through the steps to configure a SMART App Launch
1010

1111
## Prerequisites
1212
1. Intall the latest WSO2 API Manager version and install the [WSO2 Open Healthcare Accelerator](../../install-and-setup/manual.md).
13-
2. Start the WSO2 API Manager server by navigating to <APIM_HOME>/bin directory and executing this command.
13+
2. Start the WSO2 API Manager server by navigating to `<APIM_HOME>`/bin directory and executing this command.
1414
```bash
1515
./api-manager.sh
1616
```

‎en/docs/secure-health-apis/guides/smart-on-fhir-overview.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Below are the key steps involved in launching a SMART app and gaining access to
5151

5252
With the access token in hand, the app makes API requests to the EHR’s FHIR server. For example:
5353

54-
- GET /Patient/{id} to retrieve a patient’s demographics.
55-
- GET /Observation?patient={id} to access lab results.
54+
- `GET /Patient/{id}` to retrieve a patient’s demographics.
55+
- `GET /Observation?patient={id}` to access lab results.
5656

5757
Each API request includes the access token in the HTTP header (Authorization: Bearer ACCESS_TOKEN).

‎en/docusaurus.config.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ const config = {
3434
sidebarPath: require.resolve('./sidebars.js'),
3535
editUrl: 'https://github.com/wso2/open-healthcare-docs/edit/main/en/',
3636
showLastUpdateTime: true,
37+
exclude: ['**/old-content/**'],
3738
rehypePlugins: [[rehypeFixAssetImages, {baseUrl}]],
3839
},
3940
blog: false,

‎en/docusaurus.config.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ const config: Config = {
3434
sidebarPath: './sidebars.ts',
3535
editUrl: 'https://github.com/wso2/open-healthcare-docs/edit/main/en/',
3636
showLastUpdateTime: true,
37+
exclude: ['**/old-content/**'],
3738
},
3839
blog: false,
3940
theme: {

‎en/package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@
77
"postinstall": "node scripts/enable-git-last-update.js",
88
"start": "docusaurus start",
99
"build": "docusaurus build",
10+
"build:local": "docusaurus build",
1011
"swizzle": "docusaurus swizzle",
1112
"deploy": "docusaurus deploy",
1213
"clear": "docusaurus clear",
13-
"serve": "docusaurus serve",
14+
"serve": "npm run build:local && docusaurus serve",
1415
"write-translations": "docusaurus write-translations",
1516
"write-heading-ids": "docusaurus write-heading-ids",
1617
"typecheck": "tsc"

‎en/sidebars.js‎

Lines changed: 41 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,14 @@ const sidebars = {
1515
},
1616
{
1717
type: 'category',
18-
label: 'FHIR',
18+
label: 'Working with FHIR',
1919
link: { type: 'doc', id: 'fhir/guides/overview-of-fhir' },
2020
items: [
21-
'fhir/guides/overview-of-fhir',
21+
{
22+
type: 'doc',
23+
id: 'fhir/guides/overview-of-fhir',
24+
label: 'Overview of FHIR',
25+
},
2226
{
2327
type: 'category',
2428
label: 'Handling FHIR Resources',
@@ -33,30 +37,51 @@ const sidebars = {
3337
{
3438
type: 'category',
3539
label: 'Connecting to FHIR Repositories',
36-
items: ['fhir/guides/fhir-repository-connector'],
40+
items: [
41+
{
42+
type: 'doc',
43+
id: 'fhir/guides/fhir-repository-connector',
44+
label: 'Using FHIR Repository connector',
45+
},
46+
],
3747
},
3848
{
3949
type: 'category',
4050
label: 'Build your own Facade',
4151
items: [
42-
'fhir/guides/fhir-resource-api-template',
43-
'fhir/guides/metadata-api',
52+
{
53+
type: 'doc',
54+
id: 'fhir/guides/fhir-resource-api-template',
55+
label: 'Developing FHIR APIs',
56+
},
4457
],
4558
},
4659
],
4760
},
4861
{
4962
type: 'category',
50-
label: 'HL7',
63+
label: 'Working with HL7',
5164
link: { type: 'doc', id: 'hl7/guides/overview' },
5265
items: [
53-
'hl7/guides/overview',
66+
{
67+
type: 'doc',
68+
id: 'hl7/guides/overview',
69+
label: 'Overview of HL7v2',
70+
},
5471
{
5572
type: 'category',
5673
label: 'Handling HL7 Messages',
5774
items: [
58-
'hl7/guides/populating-hl7-message',
59-
'hl7/guides/parsing-and-serializing',
75+
{
76+
type: 'doc',
77+
id: 'hl7/guides/populating-hl7-message',
78+
label: 'Populating HL7 messages',
79+
},
80+
{
81+
type: 'doc',
82+
id: 'hl7/guides/parsing-and-serializing',
83+
label: 'Parsing and Serializing',
84+
},
6085
],
6186
},
6287
{
@@ -70,10 +95,14 @@ const sidebars = {
7095
{
7196
type: 'category',
7297
label: 'Build your own HL7 server',
73-
items: ['hl7/guides/hl7-server-listener'],
98+
items: [
99+
{
100+
type: 'doc',
101+
id: 'hl7/guides/hl7-server-listener',
102+
label: 'HL7 server listener',
103+
},
104+
],
74105
},
75-
'hl7/guides/validation',
76-
'hl7/guides/custom-hl7-message',
77106
],
78107
},
79108
{

‎en/sidebars.ts‎

Lines changed: 88 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,55 +16,119 @@ const sidebars: SidebarsConfig = {
1616
},
1717
{
1818
type: 'category',
19-
label: 'FHIR',
19+
label: 'Working with FHIR',
2020
link: { type: 'doc', id: 'fhir/guides/overview-of-fhir' },
21-
items: [{ type: 'autogenerated', dirName: 'fhir' }],
21+
items: [
22+
{
23+
type: 'doc',
24+
id: 'fhir/guides/overview-of-fhir',
25+
label: 'Overview of FHIR',
26+
},
27+
{
28+
type: 'category',
29+
label: 'Handling FHIR Resources',
30+
items: [
31+
'fhir/guides/populating-fhir-resources',
32+
'fhir/guides/parsing-and-serializing',
33+
'fhir/guides/validation',
34+
'fhir/guides/building-fhir-bundles',
35+
'fhir/guides/profiles-and-extensions',
36+
],
37+
},
38+
{
39+
type: 'category',
40+
label: 'Connecting to FHIR Repositories',
41+
items: [
42+
{
43+
type: 'doc',
44+
id: 'fhir/guides/fhir-repository-connector',
45+
label: 'Using FHIR Repository connector',
46+
},
47+
],
48+
},
49+
{
50+
type: 'category',
51+
label: 'Build your own Facade',
52+
items: [
53+
{
54+
type: 'doc',
55+
id: 'fhir/guides/fhir-resource-api-template',
56+
label: 'Developing FHIR APIs',
57+
},
58+
],
59+
},
60+
],
2261
},
2362
{
2463
type: 'category',
25-
label: 'HL7',
64+
label: 'Working with HL7',
2665
link: { type: 'doc', id: 'hl7/guides/overview' },
27-
items: [{ type: 'autogenerated', dirName: 'hl7' }],
66+
items: [
67+
{
68+
type: 'doc',
69+
id: 'hl7/guides/overview',
70+
label: 'Overview of HL7v2',
71+
},
72+
{
73+
type: 'category',
74+
label: 'Handling HL7 Messages',
75+
items: [
76+
{
77+
type: 'doc',
78+
id: 'hl7/guides/populating-hl7-message',
79+
label: 'Populating HL7 messages',
80+
},
81+
{
82+
type: 'doc',
83+
id: 'hl7/guides/parsing-and-serializing',
84+
label: 'Parsing and Serializing',
85+
},
86+
],
87+
},
88+
{
89+
type: 'category',
90+
label: 'Connecting to HL7 Servers',
91+
items: [
92+
'hl7/guides/connect-to-hl7-tcp-servers',
93+
'hl7/guides/connect-to-hl7-file-servers',
94+
],
95+
},
96+
{
97+
type: 'category',
98+
label: 'Build your own HL7 server',
99+
items: [
100+
{
101+
type: 'doc',
102+
id: 'hl7/guides/hl7-server-listener',
103+
label: 'HL7 server listener',
104+
},
105+
],
106+
},
107+
],
28108
},
29109
{
30110
type: 'category',
31111
label: 'Data Transformation',
32112
link: { type: 'doc', id: 'data-transformation/guides/hl7v2-fhir' },
33-
items: [{ type: 'autogenerated', dirName: 'data-transformation' }],
113+
items: [{ type: 'autogenerated', dirName: 'data-transformation/guides' }],
34114
},
35115
{
36116
type: 'category',
37117
label: 'EMR Connectivity',
38118
link: { type: 'doc', id: 'emr-connectivity/guides/emr-systems-overview' },
39-
items: [{ type: 'autogenerated', dirName: 'emr-connectivity' }],
119+
items: [{ type: 'autogenerated', dirName: 'emr-connectivity/guides' }],
40120
},
41121
{
42122
type: 'category',
43123
label: 'Secure Health APIs',
44124
link: { type: 'doc', id: 'secure-health-apis/guides/smart-on-fhir-overview' },
45-
items: [{ type: 'autogenerated', dirName: 'secure-health-apis' }],
125+
items: [{ type: 'autogenerated', dirName: 'secure-health-apis/guides' }],
46126
},
47127
{
48128
type: 'category',
49129
label: 'Advanced Topics',
50130
link: { type: 'doc', id: 'advance-topics/guides/enable-workflow' },
51-
items: [{ type: 'autogenerated', dirName: 'advance-topics' }],
52-
},
53-
{
54-
type: 'category',
55-
label: 'Other',
56-
items: [
57-
{ type: 'autogenerated', dirName: 'concepts' },
58-
{ type: 'autogenerated', dirName: 'configurations' },
59-
{ type: 'autogenerated', dirName: 'connectors' },
60-
{ type: 'autogenerated', dirName: 'resources' },
61-
{ type: 'autogenerated', dirName: 'use-cases' },
62-
'guides-overview',
63-
'references-overview',
64-
'set-up-wso2-integration-studio',
65-
'smart-specification',
66-
'page-not-found',
67-
],
131+
items: [{ type: 'autogenerated', dirName: 'advance-topics/guides' }],
68132
},
69133
],
70134
};

0 commit comments

Comments
 (0)