Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Website with documentation #2975

Closed
wants to merge 105 commits into from
Closed

Conversation

TOsmanov
Copy link
Contributor

@TOsmanov TOsmanov commented Mar 18, 2021

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 duplicates the README.md file.
  • 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

Current issues:

  • 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

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
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

The documentation has the following structure:

Documentation
│ _index.md

├───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
│ │
│ └───formats
│ │ _index.md
│ │
│ └───format-specifications
│ format-camvid.md
│ format-coco.md
│ format-cvat.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

└───for-users
│ faq.md
│ installation.md
│ installation_automatic_annotation.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
│ 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

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

yasakova-anastasia and others added 17 commits March 22, 2021 11:29
* Add support for Market-1501 dataset format

* fix data access

* Update Datumaro version

* Add transforms

* Update Changelog
* Filters new UI implemented

* Build fix

* ESLint unmached pattern error fix

* ESLint unmached pattern error fix in cvat-ui

* ESLint unmached pattern error fix in github action workflow

* Old test exclude from jest scope

* Build fix

* Build fix 1

* Build fix 2

* Tests failure fix

* Review comments fix 1 and lock-hide test fix

* lock-hide test fix

* packages fix for cor & ui

* Review comments fix

* Top bar right group layout justify fix

* Annotation page header responsive fix

* Filters modal layout fix

* Build fix. E2E case 13 workaround

* Linters fix

* Recently used empty rows fix

* Comparable fields config fix

* Build linters fix

* Minor fixes

* Fixed broken navigation

* Fixed createObjectURL

* Removed extra import

* Fixed issues with attributes

* Extra line were removed

* Fixed typos

* All renamed clientID -> objectID

* Fixed small issues

* Code refactoring

* Fixed dot-contained names

* Reordered import

Co-authored-by: Boris Sekachev <boris.sekachev@intel.com>
* cvat-player-buttons margin: 0 4px

* Rework test to set autosave interval

* Update copyright

* Remove workaround.
* CVAT 3D Annotation - Added initial cuboid placement in all views

* Fixed MACOS issue for upload of zip files

* Fixed camera axis centre issue

* Fixed ESLint import issues

* Fixed context image fit issue and resizing possible on entire grey line between views

* Fixed the multiple interection point issue

* Fixed Naming convention as per SOW

* Trigger notification

* Reverted code to test cypress tests

* Fixed review comments

* Included tooltip and added actions for keys and UIOJKL buttons

* Merged dev code, updated changelog and minor fixes

* Fixed camera positioning issue in Top View

* Reverted kubernetes auto-corrected code

* Reverted kubernetes code

Co-authored-by: cdp <cdp123>
* Cypress test. Resize views.

* Little fix
* Added support for manifest file
* Added data migration
* Updated tests
* Update CHANGELOG
* Update manifest documentation
* Fix case with 3d data

Co-authored-by: Nikita Manovich <nikita.manovich@intel.com>
)

* Case 56 remove after()

* Cypress test. Canvas 3D. Control buttom mouse interaction.

* Restart CI

* Add different command file for canvas3d feature.

* Update index.js

* Update the copyright year

* Tests adaptations
@TOsmanov TOsmanov requested a review from zhiltsov-max as a code owner March 30, 2021 07:00
@TOsmanov TOsmanov requested a review from bsekachev as a code owner March 30, 2021 13:27
@TOsmanov TOsmanov closed this Mar 30, 2021
@nmanovic
Copy link
Contributor

@TOsmanov , what was the reason to close the PR?

@TOsmanov
Copy link
Contributor Author

TOsmanov commented Mar 31, 2021

@TOsmanov , what was the reason to close the PR?

This PR has a lot of wrong commits. I plan to create a new branch and a new PR #3039 .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants