Skip to content

Commit

Permalink
Website with documentation (#3039)
Browse files Browse the repository at this point in the history
  • Loading branch information
TOsmanov authored May 20, 2021
1 parent a2df499 commit 9615436
Show file tree
Hide file tree
Showing 336 changed files with 5,456 additions and 8,204 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/github_pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Github pages

on:
push:
branches:
- develop

jobs:
deploy:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
with:
submodules: recursive
fetch-depth: 0

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: '0.83.1'
extended: true

- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: '14.x'

- name: Build docs
working-directory: ./site
run: |
npm ci
hugo --baseURL "/cvat/" --minify
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site/public
force_orphan: true
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,9 @@ yarn-error.log*
/helm-chart/values.*.yaml
/helm-chart/*.values.yaml
/helm-chart/charts/*

#Ignore website temp files
/site/public/
/site/resources/
/site/node_modules/
/site/tech-doc-hugo
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "site/themes/docsy"]
path = site/themes/docsy
url = https://github.com/google/docsy
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ annotation team. Try it online [cvat.org](https://cvat.org).

## Documentation

- [Installation guide](cvat/apps/documentation/installation.md)
- [User's guide](cvat/apps/documentation/user_guide.md)
- [Installation guide](site/content/en/docs/for-users/installation.md)
- [User's guide](https://openvinotoolkit.github.io/cvat/docs/for-users/user-guide/)
- [Django REST API documentation](#rest-api)
- [Datumaro dataset framework](https://github.com/openvinotoolkit/datumaro/blob/develop/README.md)
- [Command line interface](utils/cli/)
- [XML annotation format](cvat/apps/documentation/xml_format.md)
- [AWS Deployment Guide](cvat/apps/documentation/AWS-Deployment-Guide.md)
- [Frequently asked questions](cvat/apps/documentation/faq.md)
- [Command line interface](site/content/en/docs/for-developers/cli.md)
- [XML annotation format](site/content/en/docs/for-developers/xml_format.md)
- [AWS Deployment Guide](site/content/en/docs/for-developers/AWS-Deployment-Guide.md)
- [Frequently asked questions](site/content/en/docs/for-users/faq.md)
- [Questions](#questions)

## Screencasts
Expand Down Expand Up @@ -97,7 +97,7 @@ are visible to users.

Disabled features:

- [Analytics: management and monitoring of data annotation team](/components/analytics/README.md)
- [Analytics: management and monitoring of data annotation team](site/content/en/docs/for-developers/analytics.md)

Limitations:

Expand Down
12 changes: 8 additions & 4 deletions cvat-ui/src/components/header/header.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2020 Intel Corporation
// Copyright (C) 2020-2021 Intel Corporation
//
// SPDX-License-Identifier: MIT

Expand Down Expand Up @@ -232,7 +232,11 @@ function HeaderContainer(props: Props): JSX.Element {
About
</Menu.Item>
{renderChangePasswordItem && (
<Menu.Item className='cvat-header-menu-change-password' onClick={(): void => switchChangePasswordDialog(true)} disabled={changePasswordFetching}>
<Menu.Item
className='cvat-header-menu-change-password'
onClick={(): void => switchChangePasswordDialog(true)}
disabled={changePasswordFetching}
>
{changePasswordFetching ? <LoadingOutlined /> : <EditOutlined />}
Change password
</Menu.Item>
Expand Down Expand Up @@ -320,12 +324,12 @@ function HeaderContainer(props: Props): JSX.Element {
<Button
className='cvat-header-button'
type='link'
href={`${tool.server.host}/documentation/user_guide.html`}
href='https://openvinotoolkit.github.io/cvat/docs'
onClick={(event: React.MouseEvent): void => {
event.preventDefault();
// false positive
// eslint-disable-next-line
window.open(`${tool.server.host}/documentation/user_guide.html`, '_blank');
window.open('https://openvinotoolkit.github.io/cvat/docs');
}}
>
<QuestionCircleOutlined />
Expand Down
Loading

0 comments on commit 9615436

Please sign in to comment.