Website with documentation #3039

TOsmanov · 2021-03-31T06:08:27Z

Motivation and context

This PR contains a website created using an extended version of Hugo 0.81 (hugo documentation) and a docsy theme (docsy documentation) .

The site contains a homepage, a about page and documentation. The main documentation page has original design.
User Guide is divided into several pages for easy reading without having to scroll a long page (issue UX: User guide for hosted cvat.org needs better navigation #1630).
Added .gitmodule file to sync docsy theme
Temporary website files added to the .gitignore file
Fotter is the final

Current issues:

"Main page" - hide also not finalized
"About page" - not finalized
"The team" block on the page "about us" is not finished, the main idea of this block is a map of the world with icons of the main developers on the GitHub with the floating card of each developer when hovering on the icon.
File "site/assets/icons/logo.svg" is a copy of "cvat-ui/src/assets/cvat-logo.svg" with color changed.
Links lead to the "develop" branch (not variable)
Images on the GitHub and on the site have different paths, because of this, viewing the user guide with images is possible only on the website
The link to user guide in the README.md file is now absolute (domain name: cvat.org)
The link to the user guide from cvat (Help) should be changed to "domain_name/docs/for-users/user-guide/"

Readme files not added to the website:
cvat\cvat\apps\dataset_repo\README.md
cvat\components\serverless\README.md
cvat\cvat-canvas\README.md
cvat\cvat-canvas3d\README.md
cvat\cvat-core\README.md
cvat\cvat-data\README.md
cvat\cvat-ui\README.md
cvat\docs\rest_api_desing.md
cvat\kubernetes-templates\README.md
cvat\ssh\README.md

Change table:

Original file	Current file	Move	Divide	Rename	Compare	Delete original file
cvat/tree/develop/cvat/apps/documentation/instalation.md	cvat/site/content/en/docs/for-users/instalation.md	X			X	X
cvat/tree/develop/cvat/apps/documentation/user_guide.md	cvat/site/content/en/docs/for-users/user-guide/	X	X		X	X
cvat/tree/develop/cvat/apps/documentation/installation_automatic_annotation.md	cvat/site/content/en/docs/for-users/installation_automatic_annotation.md	X			X	X
cvat/tree/develop/cvat/apps/documentation/faq.md	cvat/site/content/en/docs/for-users/faq.md	X			X	X
cvat/tree/develop/components/analytics/README.md	cvat/site/content/en/docs/for-developers/analytics.md	X		X	X	X
cvat/tree/develop/cvat/apps/dataset_manager/formats/README.md	cvat/site/content/en/docs/for-developers/formats/	X	X	X	X	X
cvat/tree/develop/utils/cli/README.md	cvat/site/content/en/docs/for-developers/cli.md	X		X	X	X
cvat/tree/develop/cvat/apps/documentation/xml_format.md	cvat/site/content/en/docs/for-developers/xml_format.md	X			X	X
cvat/tree/develop/cvat/apps/documentation/AWS-Deployment-Guide.md	cvat/site/content/en/docs/for-developers/AWS-Deployment-Guide.md	X			X	X
cvat/tree/develop/utils/dataset_manifest/README.md	cvat/site/content/en/docs/for-developers/dataset_manifest.md	X		X	X	X
cvat/tree/develop/cvat/apps/documentation/data_on_fly.md	cvat/site/content/en/docs/for-developers/data_on_fly.md	X			X	X
cvat/tree/develop/cvat/apps/documentation/mounting_cloud_storages.md	cvat/site/content/en/docs/for-developers/mounting_cloud_storages.md	X			X	X
cvat/blob/develop/cvat/apps/documentation/backup_guide.md	cvat/site/content/en/docs/for-developers/backup_guide.md	X			X	X

The documentation has the following structure:

Documentation
├───for-developers
│       analytics.md
│       AWS-Deployment-Guide.md
│       backup_guide.md
│       cli.md
│       dataset_manifest.md
│       data_on_fly.md
│       mounting_cloud_storages.md
│       xml_format.md
│       _index.md
│
└───for-users
    │   faq.md
    │   installation.md
    │   installation_automatic_annotation.md
    │   _index.md
    │
    ├───formats
    │   │   _index.md
    │   │
    │   └───format-specifications
    │           format-camvid.md
    │           format-coco.md
    │           format-cvat.md
    │           format-datumaro.md
    │           format-icdar.md
    │           format-imagenet.md
    │           format-labelme.md
    │           format-market1501.md
    │           format-mot.md
    │           format-mots.md
    │           format-tfrecord.md
    │           format-vggface2.md
    │           format-voc.md
    │           format-widerface.md
    │           format-yolo.md
    │           _index.md
    │
    └───user-guide
        │   controls-sidebar.md
        │   creating_an_annotation_task.md
        │   downloading-annotations.md
        │   getting_started.md
        │   interface.md
        │   models.md
        │   objects-sidebar.md
        │   projects.md
        │   search.md
        │   settings.md
        │   task-synchronization.md
        │   top-panel.md
        │   types-of-shapes.md
        │   vocabulary.md
        │   workspace.md
        │   _index.md
        │
        ├───advanced
        │   │   ai-tools.md
        │   │   analytics.md
        │   │   annotation-with-polylines.md
        │   │   annotation-with-rectangle-by-4-points.md
        │   │   annotation-with-tags.md
        │   │   attribute-annotation-mode-advanced.md
        │   │   automatic-annotation.md
        │   │   filter.md
        │   │   opencv-tools.md
        │   │   review.md
        │   │   shape-grouping.md
        │   │   shape-mode-advanced.md
        │   │   shortcuts.md
        │   │   track-mode-advanced.md
        │   │   _index.md
        │   │
        │   ├───annotation-with-cuboids
        │   │       creating-the-cuboid.md
        │   │       editing-the-cuboid.md
        │   │       _index.md
        │   │
        │   ├───annotation-with-points
        │   │       liner-interpolation-with-one-point.md
        │   │       points-in-shape-mode.md
        │   │       _index.md
        │   │
        │   └───annotation-with-polygons
        │           automatic-borders.md
        │           creating-mask.md
        │           edit-polygon.md
        │           manual-drawing.md
        │           track-mode-with-polygons.md
        │           _index.md
        │
        └───basics
                attribute-annotation-mode-basics.md
                basic-navigation.md
                shape-mode-basics.md
                track-mode-basics.md
                _index.md

How has this been tested?

Checklist

I submit my changes into the develop branch
I have added description of my changes into CHANGELOG file
I have updated the documentation accordingly
I have added tests to cover my changes
I have linked related issues (read github docs)
I have increased versions of npm packages if it is necessary (cvat-canvas,
cvat-core, cvat-data and cvat-ui)

License

I submit my code changes under the same MIT License that covers the project.
Feel free to contact the maintainers if that's a concern.
I have updated the license header for each file (see an example below)

# Copyright (C) 2021 Intel Corporation
#
# SPDX-License-Identifier: MIT

Update user-guide

coveralls · 2021-04-13T08:06:17Z

Coverage decreased (-0.04%) to 73.998% when pulling 9a3d902 on TOsmanov:website into 177120b on openvinotoolkit:develop.

TOsmanov · 2021-05-19T10:10:48Z

@TOsmanov , @azhavoro , I try to follow installation instructions here: https://github.com/openvinotoolkit/cvat/blob/7152e18fadb39e9b8173ad5fd73a6a5a5542bab1/site/README.md#start-site-localy. I see 404 error when I try to open http://localhost:1313/
@nmanovic

This is probably due to recent changes in the config.toml file. You need specify baseURL="/" in config.toml before generation.

azhavoro · 2021-05-19T10:42:17Z

@TOsmanov , @azhavoro , I try to follow installation instructions here: https://github.com/openvinotoolkit/cvat/blob/7152e18fadb39e9b8173ad5fd73a6a5a5542bab1/site/README.md#start-site-localy. I see 404 error when I try to open http://localhost:1313/
@nmanovic

This is probably due to recent changes in the config.toml file. You need specify baseURL="/" in config.toml before generation.

@nmanovic does it solve the issue? If so, lets keep "/" as baseURL in the config and pass option for Hugo during build.

site/README.md

nmanovic · 2021-05-19T11:16:06Z

@TOsmanov , why do we need so many favicons?

nmanovic · 2021-05-19T11:18:43Z

@TOsmanov , should the actual icon be so small?

site/content/en/docs/for-users/user-guide/workspace.md

TOsmanov · 2021-05-19T12:35:10Z

@TOsmanov , why do we need so many favicons?

@nmanovic

To generate favicons I used the site https://cthedot.de/icongen/ as described in the docsy manual. This number of files is needed to be displayed correctly on different devices and browsers.

… developers" section description

site/README.md

site/content/en/docs/for-users/user-guide/workspace.md

site/README.md

bsekachev · 2021-05-20T09:17:52Z

site/content/en/_index.html

+++
+title = "CVAT"
+linkTitle = "CVAT"
+++
+
+{{< blocks/section height="full" color="docs" >}}
+
+<section id="temporary-page" class="mx-auto text-center py-5">
+  <div class="py-4">
+	<i class="fas fa-tools fa-7x"></i>
+  </div>
+  <div class="py-4">
+	<h1 class="text-center">This page is in development.</h1>
+  </div>
+  <div class="py-4">
+    <h3 class="text-center">
+	    Visit our <a href="https://github.com/openvinotoolkit/cvat">GitHub</a> repository.
+	</h3>
+  </div>
+</section>
+
+{{< /blocks/section >}}


I would suggest redirecting from this page to About page. I think it is a good candidate to be default page.

And add link to GitHub repository from the header

nmanovic · 2021-05-20T10:08:04Z

@TOsmanov , @azhavoro , let's commit as is and fix other problems after that. Really huge PR and it blocks documentation development.

add website

5435d83

TOsmanov marked this pull request as ready for review March 31, 2021 06:10

TOsmanov requested review from azhavoro and nmanovic as code owners March 31, 2021 06:10

delete duplicate images

98332c1

TOsmanov mentioned this pull request Mar 31, 2021

[WIP] Website with documentation #2975

Closed

8 tasks

TOsmanov added 20 commits March 31, 2021 09:23

fix README.md

9c53d32

fix faq.md

e6c6756

delete duplicate image

64a6ef5

fix links in utils/README.md

c214daa

Merge remote-tracking branch 'upstream/develop' into website

0c13212

update user-guide

afa2767

Merge remote-tracking branch 'upstream/develop' into website

0ae74b7

Merge remote-tracking branch 'upstream/develop' into website

58f220a

Update user-guide

update site footer

17c2a2a

fix footer

6dc0a66

Merge remote-tracking branch 'upstream/develop' into website

234aff6

hide main page

1237b96

update about page

353b8db

update about page

53ed47d

update about page color

d350c13

update about page change style and add location in block contact us

8b32447

fix links for site build with use command "hugo"

0bad52a

update background on page "about us"

9b258b6

fix about page

e45919d

Merge remote-tracking branch 'upstream/develop' into website

77c0e02

TOsmanov added 2 commits April 13, 2021 12:37

update readme.md for website

9a3d902

fix mistakes and remove old .md files

b380962

TOsmanov requested a review from zhiltsov-max as a code owner April 13, 2021 12:32

TOsmanov added 2 commits May 19, 2021 13:27

delete unused files

19d8aa8

update site/README.md

aa81b7a

nmanovic reviewed May 19, 2021

View reviewed changes

site/README.md Outdated Show resolved Hide resolved

nmanovic reviewed May 19, 2021

View reviewed changes

site/README.md Outdated Show resolved Hide resolved

changed default value for baseURL

114bb9f

nmanovic reviewed May 19, 2021

View reviewed changes

site/content/en/docs/for-users/user-guide/workspace.md Outdated Show resolved Hide resolved

bsekachev mentioned this pull request May 19, 2021

Context images 2D add documentation to the user guide #3214

Closed

2 tasks

TOsmanov added 3 commits May 19, 2021 15:21

fix favicons

189d0a3

fix _head.html and browserconfig.xml

948bac8

update site/README.md

41e17fa

TOsmanov added 2 commits May 19, 2021 15:38

resize featured-background.jpg

2f39443

add license in .scss files, update xml_format.md and faq.md, fix "for…

5615c9a

… developers" section description

bsekachev reviewed May 19, 2021

View reviewed changes

site/README.md Outdated Show resolved Hide resolved

TOsmanov added 2 commits May 19, 2021 19:29

fix mistakes in site/README.md and delete unused file

6a53195

fix links

8f73953

nmanovic reviewed May 19, 2021

View reviewed changes

site/content/en/docs/for-users/user-guide/workspace.md Show resolved Hide resolved

fix markup in _index.html

a0a8ff6

azhavoro reviewed May 20, 2021

View reviewed changes

site/README.md Outdated Show resolved Hide resolved

Update site/README.md

94cb5a9

bsekachev reviewed May 20, 2021

View reviewed changes

site/README.md Outdated Show resolved Hide resolved

bsekachev reviewed May 20, 2021

View reviewed changes

fix mistakes in README.md and xml_format.md

a9fc145

nmanovic approved these changes May 20, 2021

View reviewed changes

nmanovic merged commit 9615436 into cvat-ai:develop May 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Website with documentation #3039

Website with documentation #3039

TOsmanov commented Mar 31, 2021 •

edited

Loading

coveralls commented Apr 13, 2021 •

edited

Loading

TOsmanov commented May 19, 2021 •

edited

Loading

azhavoro commented May 19, 2021

nmanovic commented May 19, 2021

nmanovic commented May 19, 2021

TOsmanov commented May 19, 2021

bsekachev May 20, 2021

bsekachev May 20, 2021

nmanovic commented May 20, 2021

Website with documentation #3039

Website with documentation #3039

Conversation

TOsmanov commented Mar 31, 2021 • edited Loading

Motivation and context

Change table:

The documentation has the following structure:

How has this been tested?

Checklist

License

coveralls commented Apr 13, 2021 • edited Loading

TOsmanov commented May 19, 2021 • edited Loading

azhavoro commented May 19, 2021

nmanovic commented May 19, 2021

nmanovic commented May 19, 2021

TOsmanov commented May 19, 2021

bsekachev May 20, 2021

Choose a reason for hiding this comment

bsekachev May 20, 2021

Choose a reason for hiding this comment

nmanovic commented May 20, 2021

TOsmanov commented Mar 31, 2021 •

edited

Loading

coveralls commented Apr 13, 2021 •

edited

Loading

TOsmanov commented May 19, 2021 •

edited

Loading