Skip to content

Commit 413df69

Browse files
userlocalhostuserlocalhost
authored
Merge pull request #51 from userlocalhost/fixed/configuration_of_gh-pages
Update configurations and contents for documentation of GitHub page
2 parents 418e412 + a33a01c commit 413df69

File tree

173 files changed

+2536
-4167
lines changed

Some content is hidden

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

173 files changed

+2536
-4167
lines changed

‎.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
__pycache__/
1212
local_settings.py
1313
db.sqlite3
14-
media
1514

1615
### Python ###
1716
# Byte-compiled / optimized / DLL files
@@ -164,3 +163,5 @@ airone/settings.py
164163
# VS Code
165164
.vscode/
166165

166+
# ignores generated by Hugo for contents of gh-pages
167+
docs/public

‎.travis.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
language: go
2+
install:
3+
- curl -LO https://github.com/gohugoio/hugo/releases/download/v0.74.3/hugo_0.74.3_Linux-64bit.deb
4+
- sudo dpkg -i hugo_0.74.3_Linux-64bit.deb
5+
6+
script:
7+
- sh -c 'cd docs; hugo'
8+
after_success:
9+
- scripts/deploy_gh_pages.sh

‎docs/config.toml

-109
This file was deleted.

‎docs/config.yaml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
baseURL: http://airone-doc.dmmlabs.com/
3+
title: AirOne
4+
theme: hugo-geekdoc
5+
pygmentsUseClasses: true
6+
pygmentsCodeFences: true
7+
timeout: 180000
8+
9+
# Geekdoc configuration
10+
disablePathToLower: true
11+
enableGitInfo: true
12+
13+
# Needed for mermaid shortcodes
14+
markup:
15+
goldmark:
16+
renderer:
17+
unsafe: true
18+
tableOfContents:
19+
startLevel: 1
20+
endLevel: 9
21+
22+
params:
23+
geekdocToC: 3
24+
geekdocLogo: /media/logo.png
25+
26+
geekdocSearch: true

‎docs/content/_index.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
11
---
2-
date: 2020-08-25
3-
lastmod: 2020-08-25
4-
publishdate: 2020-08-25
5-
title: AirOne Overview
6-
description: Abstract of AirOne
2+
title: AirOne
73
---
84

9-
# AirOne Overview
10-
115
(TBD)

‎docs/content/advanced/_index.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Advanced Topics
3+
weight: 10
4+
---
5+

‎docs/content/advanced/custom_view.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: CustomView
3+
weight: 0
4+
---
5+
6+
(TBD)

‎docs/content/getting-started/_index.md

-16
This file was deleted.

‎docs/content/getting-started/installation.md

-10
This file was deleted.

‎docs/content/getting-started/tutorial.md

-10
This file was deleted.

‎docs/content/getting_started/_index.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Getting Started
3+
weight: 0
4+
---

‎docs/content/getting_started/installation.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Installation and Configuration
3+
weight: 10
4+
---
5+
6+
(TBD)

‎docs/content/getting_started/overview.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Overview
3+
weight: 0
4+
---
5+
6+
(TBD)

‎docs/content/getting_started/tutorial.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Tutorial
3+
weight: 20
4+
---
5+
6+
(TBD)

‎docs/content/posts/_index.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: News
3+
type: posts
4+
weight: 10
5+
geekdocHidden: true
6+
---

‎docs/content/post/changelog.md ‎docs/content/release_note/CHANGELOG.md

+23-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,30 @@
11
---
22
title: Changelog
3-
description: ""
4-
date: 2020-08-25
5-
menu: main
3+
weight: 10
64
---
75

6+
7+
## in development
8+
9+
### Fixed
10+
11+
* Fixed a bug not to change referral values when entity was edited
12+
13+
## v2.4.0
14+
15+
### Changed
16+
* Change implementation about editing Entity to disable to edit type of EntityAttr
17+
18+
## v2.3.1
19+
20+
### Fixed
21+
* Fixed a problem that date value won't be shown at advanced search result
22+
23+
## v2.3.0
24+
25+
### Added
26+
* Added new AttributeType `array group` that could contain multiple Group referral in an Attribute value
27+
828
## v2.2.0
929

1030
### Added

‎docs/content/release_note/_index.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Release Notes
3+
weight: 20
4+
---

‎docs/data/menu/more.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
more:
3+
- name: News
4+
ref: "/posts"
5+
icon: "notification"
6+
- name: Releases
7+
ref: "https://github.com/dmm-com/airone/releases"
8+
external: true
9+
icon: "download"
10+
- name: "View Source"
11+
ref: "https://github.com/dmm-com/airone"
12+
external: true
13+
icon: "github"

‎docs/public/404.html

-87
This file was deleted.

0 commit comments

Comments
 (0)