Skip to content

Commit 39cb794

Browse files
rohit053rohit053
committed
Initial Commit for QloApps User Guide documentation
0 parents  commit 39cb794

File tree

488 files changed

+36456
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

488 files changed

+36456
-0
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Deploy VuePress to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- master # Trigger deployment when the main branch is updated (update as per your default branch)
7+
8+
jobs:
9+
build-and-deploy:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
# Checkout the repository
14+
- name: Checkout code
15+
uses: actions/checkout@v3
16+
17+
# Set up Node.js
18+
- name: Set up Node.js
19+
uses: actions/setup-node@v3
20+
with:
21+
node-version: '18' # Use an appropriate Node.js version
22+
23+
# Install dependencies
24+
- name: Install dependencies
25+
run: npm install
26+
27+
# Build the VuePress site
28+
- name: Build VuePress site
29+
run: npm run docs:build # Ensure your `package.json` has "docs:build" as the build script
30+
31+
# Deploy to GitHub Pages
32+
- name: Deploy to GitHub Pages
33+
uses: peaceiris/actions-gh-pages@v3
34+
with:
35+
github_token: ${{ secrets.GITHUB_TOKEN }}
36+
publish_dir: ./docs/.vuepress/dist # Adjust this path if your VuePress output is elsewhere
37+
cname: docs.qloapps.com

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
docs/.vuepress/dist
2+
node_modules/
3+
.vscode/

‎Readme.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# QloApps User Guide
2+
3+
The online version of this documentation is hosted at [https://docs.qloapps.com](https://docs.qloapps.com/).
4+
5+
## Contribution guide
6+
7+
Contributions are more than welcome! To start contributing to this documentation, you need to deploy it locally and make the required changes. Here is how to deploy:
8+
9+
- Fork this repository.
10+
11+
- Clone your fork.
12+
13+
- Follow the [Install dependencies](#Install-dependencies) section.
14+
15+
Before making a contribution using a pull request make sure:
16+
17+
- If adding a new page, its topic has not been covered already.
18+
19+
- To use proper terminology as used in this documentation when referring to parts of QloApps.
20+
21+
- To use `kebab-case` when adding a new file. For example, `new-file-one.md`, `new-file-two.md` etc.
22+
23+
Follow VuePress official guide at [https://vuepress.vuejs.org/guide](https://vuepress.vuejs.org/guide/) for further help.
24+
25+
## Install dependencies
26+
27+
- Clone the repository somewhere on your system:
28+
```
29+
git clone https://github.com/Qloapps/qloapps-docs.git
30+
```
31+
32+
- Switch to the `qloapps-docs` directory:
33+
```
34+
cd qloapps-docs
35+
```
36+
37+
- Install all dependencies:
38+
```
39+
npm install
40+
```
41+
42+
- Build and deploy your repository:
43+
```
44+
npm run docs:dev
45+
```
46+
47+
- Open your browser and go to [http://localhost:8080](http://localhost:8080).

‎docs/.vuepress/components/Copyright.vue‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<template>
2+
<div>
3+
Copyright © {{ date }} QloApps
4+
</div>
5+
</template>
6+
7+
<script>
8+
export default {
9+
data() {
10+
return {
11+
date: new Date().getFullYear()
12+
}
13+
}
14+
}
15+
</script>

‎docs/.vuepress/config.js‎

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
const { description, name } = require('../../package')
2+
3+
module.exports = {
4+
base: '/',
5+
title: name,
6+
description: description,
7+
head: [
8+
['link', { rel: "icon", type: "image/png", href: "/favicon.ico"}],
9+
],
10+
themeConfig: {
11+
logo: '/logo.png',
12+
docsRepo: 'Qloapps/user-guide',
13+
docsDir: 'docs',
14+
editLinks: true,
15+
editLinkText: 'Help us improve this page!',
16+
lastUpdated: true,
17+
nav: [
18+
{
19+
text: 'Download',
20+
link: 'https://qloapps.com/download/',
21+
},
22+
{
23+
text: 'Development Documentation',
24+
link: 'https://devdocs.qloapps.com/'
25+
},
26+
{
27+
text: 'Forum',
28+
link: 'https://forums.qloapps.com/'
29+
},
30+
{
31+
text: 'Extensions',
32+
link: 'https://qloapps.com/addons/'
33+
},
34+
],
35+
36+
sidebar: [
37+
{
38+
title: 'Introduction',
39+
path: '/introduction/',
40+
collapsable: true,
41+
},
42+
{
43+
title: 'Dashboard',
44+
path: '/dashboard/',
45+
collapsable: true,
46+
children: [
47+
['dashboard/guest_insights/', 'Guest Insights'],
48+
['dashboard/filter/', 'Filters'],
49+
['dashboard/occupancy/', 'Occupancy'],
50+
['dashboard/operations_today/', 'Operations Today'],
51+
['dashboard/revenue/', 'Revenue'],
52+
['dashboard/insights/', 'Insights'],
53+
['dashboard/availabilty/', 'Availabilty'],
54+
['dashboard/activity_overview/', 'Activity Overview'],
55+
['dashboard/performance/', 'Performance'],
56+
['dashboard/sales/', 'Sales'],
57+
['dashboard/targets/', 'Targets'],
58+
['dashboard/updates_hc/', 'Updates and Help center'],
59+
]
60+
},
61+
{
62+
title: 'Catalog',
63+
path: '/catalog/',
64+
collapsable: true,
65+
children: [
66+
['catalog/manage_room_types/', 'Manage Room Types'],
67+
['catalog/manage_service_products/', 'Manage Services Products'],
68+
['catalog/categories/', 'Categories'],
69+
['catalog/features/', 'Features'],
70+
]
71+
},
72+
{
73+
title: 'Customers',
74+
path: '/customers/',
75+
collapsable: true,
76+
children: [
77+
['customers/customers/customers', 'Customers'],
78+
['customers/address/address', 'Addresses'],
79+
['customers/groups/groups', 'Groups'],
80+
['customers/booking_carts/booking_carts', 'Booking Carts'],
81+
['customers/customer_service/customer_service', 'Customer Service'],
82+
['customers/contacts/contacts', 'Contacts'],
83+
['customers/titles/titles', 'Titles']
84+
]
85+
},
86+
{
87+
title: 'Orders',
88+
path: '/orders/',
89+
collapsable: true,
90+
children: [
91+
['orders/orders/', 'Orders'],
92+
['orders/invoices/', 'Invoices'],
93+
['orders/credit_slips/', 'Credit Slips'],
94+
['orders/statuses/', 'Statuses'],
95+
['orders/order_messages/', 'Order Messages'],
96+
]
97+
},
98+
{
99+
title: 'Discounts',
100+
path: '/discounts/',
101+
collapsable: true,
102+
children: [
103+
['discounts/cart_rule/', 'Cart Rules'],
104+
['discounts/catalog_price_rules/', 'Catalog Price Rules'],
105+
]
106+
},
107+
{
108+
title: 'Hotel Reservation System',
109+
path: '/hrs/',
110+
collapsable: true,
111+
children: [
112+
['hrs/manage_hotel/', 'Manage Hotel'],
113+
['hrs/book_now/', 'Book Now'],
114+
['hrs/manage_hotel_features/', 'Manage Hotel Features'],
115+
['hrs/manage_refund_rules/', 'Manage Order Refund Rules'],
116+
['hrs/manage_refund_request/', 'Manage Order Refund Request'],
117+
['hrs/general_settings/', 'General Settings'],
118+
]
119+
},
120+
{
121+
title: 'Channel Manager',
122+
path: '/channel_manager/',
123+
collapsable: true,
124+
},
125+
{
126+
title: 'Modules and Services',
127+
path: '/modules/',
128+
collapsable: true,
129+
children: [
130+
['modules/manage_modules/', 'Manage Modules'],
131+
['modules/modules_catalog/', 'Modules catalog'],
132+
['modules/positions/', 'Positions'],
133+
['modules/payments/', 'Payments'],
134+
]
135+
},
136+
{
137+
title: 'Localization',
138+
path: '/localization/',
139+
collapsable: true,
140+
children: [
141+
['localization/localization/', 'Localization'],
142+
['localization/languages/', 'Languages'],
143+
['localization/zones/', 'Zones'],
144+
['localization/country/', 'Countries'],
145+
['localization/states/', 'States'],
146+
['localization/currency/', 'Currencies'],
147+
['localization/taxes/', 'Taxes'],
148+
['localization/tax_rules/', 'Tax Rules'],
149+
['localization/translations/', 'Translations'],
150+
]
151+
},
152+
{
153+
title: 'Preferences',
154+
path: '/preferences/',
155+
collapsable: true,
156+
children: [
157+
['preferences/general/', 'General'],
158+
['preferences/orders/', 'Orders'],
159+
['preferences/room_types/', 'Room Types'],
160+
['preferences/customers/', 'Customers'],
161+
['preferences/themes/', 'Themes'],
162+
['preferences/seo_url/', 'SEO & URLs'],
163+
['preferences/cms/', 'CMS'],
164+
['preferences/images/', 'Images'],
165+
['preferences/store_contacts/', 'Store Contacts'],
166+
['preferences/maintenance/', 'Maintenance'],
167+
['preferences/geolocation/', 'Geolocation'],
168+
]
169+
},
170+
{
171+
title: 'stats',
172+
path: '/stats/',
173+
collapsable: false,
174+
},
175+
{
176+
title: 'Administration',
177+
path: '/administration/',
178+
collapsable: true,
179+
children: [
180+
['administration/preferences/', 'Preferences'],
181+
['administration/quick_access/', 'Quick Access'],
182+
['administration/employees/', 'Employees'],
183+
['administration/profile/', 'Profile'],
184+
['administration/permissions/', 'Permissions'],
185+
['administration/menus/', 'Menus'],
186+
]
187+
},
188+
{
189+
title: 'Advanced Parameter',
190+
path: '/advance_parameter/',
191+
collapsable: true,
192+
children: [
193+
['advance_parameter/configuration_information/', 'Configuration Information'],
194+
['advance_parameter/performance/', 'Performance'],
195+
['advance_parameter/email/', 'E-mail'],
196+
['advance_parameter/csv_import/', 'CSV Import'],
197+
['advance_parameter/db_backup/', 'DB Backup'],
198+
['advance_parameter/sql_manager/', 'SQL Manager'],
199+
['advance_parameter/logs/', 'Logs'],
200+
['advance_parameter/webservices/', 'Webservice'],
201+
]
202+
},
203+
]
204+
},
205+
206+
/**
207+
* Apply plugins，ref：https://v1.vuepress.vuejs.org/zh/plugin/
208+
*/
209+
plugins: [
210+
[
211+
'@vuepress/medium-zoom',
212+
{
213+
background: '#000',
214+
}
215+
],
216+
'@vuepress/plugin-back-to-top',
217+
]
218+
}

‎docs/.vuepress/enhanceApp.js‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/**
2+
* Client app enhancement file.
3+
*
4+
* https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements
5+
*/
6+
7+
export default ({
8+
Vue, // the version of Vue being used in the VuePress app
9+
options, // the options for the root Vue instance
10+
router, // the router instance for the app
11+
siteData // site metadata
12+
}) => {
13+
// ...apply enhancements for the site.
14+
}

‎docs/.vuepress/photoswipe.js‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// .vuepress/client.ts
2+
const defineUserConfig = require('@vuepress/cli');
3+
const defaultTheme = require('../../node_modules/@vuepress/theme-default');
4+
const photoswipe = require('../../node_modules/vuepress-plugin-photo-swipe');
5+
6+
7+
export default defineUserConfig({
8+
base,
9+
10+
title: "PhotoSwipe",
11+
description: "Image preview plugin for VuePress2",
12+
13+
theme: defaultTheme({
14+
logo: "https://theme-hope-assets.vuejs.press/logo.svg",
15+
16+
repo: "vuepress-theme-hope/vuepress-theme-hope/tree/main/demo/photo-swipe/",
17+
18+
navbar: [
19+
{ text: "Home", link: "/" },
20+
{ text: "Test", link: "/test" },
21+
],
22+
23+
themePlugins: {
24+
mediumZoom: false,
25+
},
26+
}),
27+
28+
plugins: [photoSwipePlugin()],
29+
});

‎docs/.vuepress/public/favicon.ico‎

1.12 KB
Binary file not shown.

‎docs/.vuepress/public/logo.png‎

20.7 KB
Loading

‎docs/.vuepress/styles/index.styl‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
/**
2+
* Custom Styles here.
3+
*
4+
* ref：https://v1.vuepress.vuejs.org/config/#index-styl
5+
*/
6+
7+
img
8+
margin: auto
9+
display: block
10+
11+
.content__devdocs {
12+
padding: .1rem 1.5rem;
13+
border-left-width: .5rem;
14+
border-left-style: solid;
15+
margin: 1rem 0;
16+
background-color: #f3f5f7;
17+
border-color: #42b983;
18+
}

0 commit comments

Comments
 (0)