Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
N
nexpie-grafana-theme
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Registry
Registry
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Kornkitt Poolsup
nexpie-grafana-theme
Commits
22a7eaf2
Commit
22a7eaf2
authored
May 27, 2016
by
Torkel Ödegaard
Browse files
Options
Browse Files
Download
Plain Diff
Merge branch 'master' into export-dashboard
parents
540def2c
bf90fbc6
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
51 additions
and
5 deletions
+51
-5
docs/README.md
+48
-5
docs/mkdocs.yml
+1
-0
public/app/features/templating/templateValuesSrv.js
+2
-0
No files found.
docs/README.md
View file @
22a7eaf2
To build the docs locally, you need to have docker installed. The docs are built using a custom
[
docker
](
https://www.docker.com/
)
image and
[
mkdocs
](
http://www.mkdocs.org/
)
.
# Building The Docs
Build the
`grafana/docs-base:latest`
image:
To build the docs locally, you need to have docker installed. The
docs are built using a custom
[
docker
](
https://www.docker.com/
)
image
and the
[
mkdocs
](
http://www.mkdocs.org/
)
tool.
**Prepare the Docker Image**
:
Build the
`grafana/docs-base:latest`
image. Run these commands in the
same directory this file is in.
**Note**
that you may require
``sudo``
when running
``make docs-build``
depending on how your system's docker
service is configured):
```
$ git clone https://github.com/grafana/docs-base
...
...
@@ -9,10 +17,45 @@ $ cd docs-base
$ make docs-build
```
To build the docs:
**Build the Documentation**
:
Now that the docker image has been prepared we can build the
docs. Switch your working directory back to the directory this file
(README.md) is in and run (possibly with
``sudo``
):
```
$ cd docs
$ make docs
```
This command will not return control of the shell to the user. Instead
the command is now running a new docker container built from the image
we created in the previous step.
Open
[
localhost:8180
](
http://localhost:8180
)
to view the docs.
**Note**
that after running
``make docs``
you may notice a message
like this in the console output
> Running at: http://0.0.0.0:8000/
This is misleading. That is
**not**
the port the documentation is
served from. You must browse to port
**8180**
to view the new
documentation.
# Adding a New Page
Adding a new page requires updating the
``mkdocs.yml``
file which is
located in this directory.
For example, if you are adding documentation for a new HTTP API called
``preferences``
you would:
1.
Create the file
``docs/sources/http_api/preferences.md``
1.
Add a reference to it in
``docs/sources/http_api/overview.md``
1.
Update the list under the
**pages**
key in the
``docs/mkdocs.yml``
file with a reference to your new page:
```yaml
- ['http_api/preferences.md', 'API', 'Preferences API']
```
docs/mkdocs.yml
View file @
22a7eaf2
...
...
@@ -84,6 +84,7 @@ pages:
-
[
'
http_api/user.md'
,
'
API'
,
'
User
API'
]
-
[
'
http_api/admin.md'
,
'
API'
,
'
Admin
API'
]
-
[
'
http_api/snapshot.md'
,
'
API'
,
'
Snapshot
API'
]
-
[
'
http_api/preferences.md'
,
'
API'
,
'
Preferences
API'
]
-
[
'
http_api/other.md'
,
'
API'
,
'
Other
API'
]
-
[
'
plugins/index.md'
,
'
Plugins'
,
'
Overview'
]
...
...
public/app/features/templating/templateValuesSrv.js
View file @
22a7eaf2
...
...
@@ -105,6 +105,8 @@ function (angular, _, kbn) {
return
op
.
text
===
urlValue
||
op
.
value
===
urlValue
;
});
option
=
option
||
{
text
:
urlValue
,
value
:
urlValue
};
self
.
updateAutoInterval
(
variable
);
return
self
.
setVariableValue
(
variable
,
option
,
true
);
});
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment