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
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
105 commits
Select commit Hold shift + click to select a range
2a78dfb
User Guide update v1
Dec 13, 2019
b69fa50
Fix codacy issue and missing definitions
Dec 16, 2019
15588bc
Fix codacy issue v1
Dec 17, 2019
f2e92a9
Fix codacy issue v2
Dec 17, 2019
a167232
Fix codacy issue and ordered lists
Dec 17, 2019
107ffc9
Fix codacy issue, ordered lists and hyperlink
Dec 17, 2019
ccb58ec
Fix codacy issue and ordered lists v3
Dec 17, 2019
b24bf5b
Fix ordered lists v4
Dec 17, 2019
f0b878c
Fix codacy issues v5
Dec 17, 2019
b8b7761
Cancel the "task sync" image change
Dec 17, 2019
fba03a8
Fix codacy issue v6
Dec 17, 2019
93cbcde
Fix codacy issues v7
Dec 17, 2019
f496874
Fix codacy issues v8
Dec 17, 2019
62f6306
Fix codacy issues v9
Dec 17, 2019
45c1add
Update image131.jpg
Dec 17, 2019
857d206
Fix codacy issues v10
Dec 18, 2019
fb57b2e
Fix codacy issues v11
Dec 18, 2019
2345f52
Fix codacy issues v12
Dec 18, 2019
fb67a52
Fix codacy issues v13
Dec 18, 2019
80cdb6a
Fix codacy issues v14
Dec 18, 2019
4c0e1fa
Fix codacy issues v15
Dec 18, 2019
de45cc2
Fix codacy issues v16
Dec 18, 2019
80d0855
Fix codacy issues v17
Dec 18, 2019
175c5f3
Fix codacy issues v18
Dec 18, 2019
8ff0e06
Fix codacy issues v19
Dec 18, 2019
5ab6e03
Fix codacy issues v20
Dec 18, 2019
bdf7b74
Fix codacy issues v21
Dec 18, 2019
a871331
Fix codacy issues v22
Dec 18, 2019
299a2e7
Fix codacy issues v22
Dec 18, 2019
dadd30d
Fix codacy issues v23
Dec 18, 2019
54d17b5
Fix codacy issues v24
Dec 18, 2019
63c2d1a
Fix codacy issues v24
Dec 18, 2019
4704b00
Fix codacy issues v25
Dec 18, 2019
72072dd
Fix codacy issues v25
Dec 18, 2019
d582349
Fix codacy issues v26
Dec 18, 2019
6fe48c6
Fix codacy issues v27
Dec 18, 2019
057a8b8
Fix codacy issues v28
Dec 18, 2019
bccbde9
Fix codacy issues v29
Dec 18, 2019
d417d24
Update section "Model Manager" and update images
Dec 19, 2019
d85b85f
Revert "Update section "Model Manager" and update images"
Dec 19, 2019
9c3accb
Merge remote-tracking branch 'upstream/develop' into User-Guide-update
Dec 19, 2019
3ec9485
Updating the Model Manager section and images
Dec 19, 2019
8df45cc
Fix codacy issues
Dec 19, 2019
241e35f
Fix codacy issues v2
Dec 20, 2019
6dde18d
Merge remote-tracking branch 'upstream/develop' into develop
Dec 23, 2019
99be418
Updating text and images in the Auto Annotation section
Dec 23, 2019
1d0063a
Fix codacy issues v1
Dec 23, 2019
a42f022
Fix codacy issues v2
Dec 23, 2019
1546e81
Change extension "JPG" to "jpg"
Dec 23, 2019
aa3f677
Delete images with the extension "JPG"
Dec 23, 2019
e84facd
Added images with the extension "jpg"
Dec 23, 2019
d6e0791
Added image "ReID merge" and change image "search"
Dec 24, 2019
cfc7559
Merge remote-tracking branch 'upstream/develop' into develop
Dec 24, 2019
6d35976
Update image "Analytics"
Dec 24, 2019
bb36340
Fix user_guide.md
Dec 24, 2019
e5a9c4d
Fix user_guide.md v2
Dec 25, 2019
525dc15
Merge remote-tracking branch 'upstream/develop' into develop
Dec 25, 2019
d36079f
Update section "Task synchronization with a repository" and update im…
Dec 25, 2019
0f13df9
Merge remote-tracking branch 'upstream/develop' into develop
Apr 3, 2020
74ac6c9
Merge remote-tracking branch 'upstream/develop' into develop
Apr 14, 2020
52fdad8
Merge branch 'develop' of https://github.com/TOsmanov/cvat into develop
Apr 17, 2020
629f02f
Merge branch 'develop' of https://github.com/TOsmanov/cvat into develop
TOsmanov Sep 25, 2020
e748a01
add website
Mar 18, 2021
1ee26d7
add website
Mar 18, 2021
f21457c
add website content
Mar 18, 2021
fc8745a
fix .gitignore
Mar 18, 2021
038e3b3
delete old color scheme in scss
Mar 18, 2021
6bf40f8
remove debug.log
Mar 18, 2021
3269d0f
add README.md for site
Mar 19, 2021
09d24a8
fix: cvat/requirements/base.txt to reduce vulnerabilities (#2977)
snyk-bot Mar 19, 2021
dea2835
fix mistakes in readme.md
Mar 19, 2021
eb1cb83
Cypress test. Autoborder handler. (#2965)
dvkruchinin Mar 19, 2021
305404f
updated readme.md, site config and documentation markup
Mar 19, 2021
5f50eee
fix link on gitter in config.toml
Mar 19, 2021
c3fb14b
Cypress/unit tests. Label deleting feature. (#2953)
dvkruchinin Mar 19, 2021
2c5188f
Add label check on import (#2935)
Mar 19, 2021
9e10f5e
Update Cypress test for check issue 2968. (#2974)
dvkruchinin Mar 19, 2021
ea83f18
Bump djangorestframework from 3.11.1 to 3.11.2 in /cvat/requirements …
dependabot[bot] Mar 20, 2021
750d9cc
fix: upgrade antd from 4.12.3 to 4.13.0 (#2988)
snyk-bot Mar 22, 2021
d62e176
pcd/test adaptation to cvat3d-m4 (#2981)
dvkruchinin Mar 22, 2021
ce1666f
Support for Market-1501 dataset format (#2869)
yasakova-anastasia Mar 22, 2021
11d818d
Annotations filters new UI (#2871)
vnishukov Mar 22, 2021
4f37f5f
update site
TOsmanov Mar 22, 2021
476bd76
fix: upgrade @types/react-router from 5.1.11 to 5.1.12 (#2997)
snyk-bot Mar 23, 2021
4f7b1f9
Cypress. Fix some tests. Rework margin. (#3001)
dvkruchinin Mar 23, 2021
8ef7a92
fix hyperlinks
TOsmanov Mar 23, 2021
538bc93
CVAT 3D - Milestone-4 (#2891)
manasars Mar 23, 2021
e41c301
Cypress test. Canvas 3d-m4. Check resize views. (#2995)
dvkruchinin Mar 23, 2021
73b0c53
fix codacy issues
TOsmanov Mar 24, 2021
b2e1455
Increased left padding on the sidebar of documentation
TOsmanov Mar 24, 2021
4e5acf9
fix padding-left
TOsmanov Mar 24, 2021
6c38ad0
Manifest (#2763)
Marishka17 Mar 24, 2021
73d7fd0
Fixed unsupported methods (#3008)
Mar 24, 2021
1efd21a
Cypress test. Canvas 3D. Control button mouse interaction. (#3003)
dvkruchinin Mar 24, 2021
61afff5
fix config.toml
TOsmanov Mar 25, 2021
9c5226c
fix config.toml
TOsmanov Mar 26, 2021
d04aa3f
update main documentation page
TOsmanov Mar 30, 2021
521b6ac
update website
TOsmanov Mar 30, 2021
bb2b131
delete image duplicates
TOsmanov Mar 30, 2021
3177935
fix links in readme.md
TOsmanov Mar 30, 2021
2bfe7e9
fix main documentation page
TOsmanov Mar 30, 2021
2891dd1
fix analytics.md and cli.md, delete duplicates
TOsmanov Mar 30, 2021
00a8fd9
fix compare issues v1
TOsmanov Mar 30, 2021
0c18a6a
Merge branch 'develop' of https://github.com/TOsmanov/cvat into develop
TOsmanov Mar 30, 2021
2a21328
Merge branch 'site' of https://github.com/TOsmanov/cvat into site
TOsmanov Mar 30, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,9 @@ yarn-error.log*
#Ignore Cypress tests temp files
/tests/cypress/fixtures
/tests/cypress/screenshots

#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
1 change: 1 addition & 0 deletions site/assets/icons/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions site/assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/*

Add styles or override variables from the theme here.

*/

$enable-gradients: false;
$enable-rounded: true;
$enable-shadows: true;
186 changes: 186 additions & 0 deletions site/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
aseURL = "cvat.org"
title = "CVAT"

sidebar_menu_compact = true

enableRobotsTXT = true

# Hugo allows theme composition (and inheritance). The precedence is from left to right.
theme = ["docsy"]

# Will give values to .Lastmod etc.
enableGitInfo = true

# Language settings
contentDir = "content/en"
defaultContentLanguage = "en"
defaultContentLanguageInSubdir = false
# Useful when translating.
enableMissingTranslationPlaceholders = true

disableKinds = ["taxonomy", "taxonomyTerm"]

# Highlighting config
pygmentsCodeFences = true
pygmentsUseClasses = false
# Use the new Chroma Go highlighter in Hugo.
pygmentsUseClassic = false
#pygmentsOptions = "linenos=table"
# See https://help.farbox.com/pygments.html
pygmentsStyle = "tango"

# Configure how URLs look like per section.
[permalinks]
blog = "/:section/:year/:month/:day/:slug/"

## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
[blackfriday]
plainIDAnchors = true
hrefTargetBlank = true
angledQuotes = false
latexDashes = true

# Image processing configuration.
[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"

[services]
[services.googleAnalytics]
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
id = "UA-00000000-0"

# Language configuration

[languages]
[languages.en]
title = ""
description = "CVAT site"
languageName ="English"
# Weight used for sorting.
weight = 1

[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
[markup.highlight]
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
style = "tango"
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
# guessSyntax = "true"

# Everything below this are Site Params

# Comment out if you don't want the "print entire section" link enabled.
[outputs]
section = ["HTML", "print"]

[params]
copyright = "The Docsy Authors"
privacy_policy = "https://policies.google.com/privacy"

# First one is picked as the Twitter card image if not set on page.
# images = ["images/project-illustration.png"]

# Menu title if your navbar has a versions selector to access old versions of your site.
# This menu appears only if you have at least one [params.versions] set.
version_menu = "Releases"

# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
archived_version = false

# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# current doc set.
version = "0.0"

# A link to latest version of the docs. Used in the "version-banner" partial to
# point people to the main doc site.
url_latest_version = "https://example.com"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/opencv/cvat"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo = "https://github.com/opencv/cvat"

# Specify a value here if your content directory is not in your repo's root directory
# github_subdir = ""

# Uncomment this if you have a newer GitHub repo with "main" as the default branch,
# or specify a new value if you want to reference another branch in your GitHub links
# github_branch= "main"

# Google Custom Search Engine ID. Remove or comment out to disable search.
# gcs_engine_id = "011737558837375720776:fsdu1nryfng"

# Enable Algolia DocSearch
algolia_docsearch = false

# Enable Lunr.js offline search
offlineSearch = true

# Enable syntax highlighting and copy buttons on code blocks with Prism
prism_syntax_highlighting = false

# User interface configuration
[params.ui]
# Enable to show the side bar menu in its compact state.
sidebar_menu_compact = true
ul_show = 2
# Set to true to disable breadcrumb navigation.
breadcrumb_disable = false
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
sidebar_search_disable = true
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
navbar_logo = true
# Set to true to disable the About link in the site footer
footer_about_disable = false

# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
# add "hide_feedback: true" to the page's front matter.
[params.ui.feedback]
enable = true
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'

# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
# add "hide_readingtime: true" to the page's front matter
[params.ui.readingtime]
enable = false

[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
[[params.links.user]]
name = "User mailing list"
url = "https://example.org/mail"
icon = "fa fa-envelope"
desc = "Discussion and help from your fellow users"
[[params.links.user]]
name ="Gitter"
url = "https://gitter.im/opencv-cvat"
icon = "fab fa-gitter"
desc = "Follow us on Twitter to get the latest news!"
[[params.links.user]]
name = "Stack Overflow"
url = "https://stackoverflow.com/search?q=%23cvat"
icon = "fab fa-stack-overflow"
desc = "Practical questions and curated answers"
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
[[params.links.developer]]
name = "GitHub"
url = "https://github.com/openvinotoolkit/cvat"
icon = "fab fa-github"
desc = "Development takes place here!"
[[params.links.developer]]
name = "Developer mailing list"
url = "https://example.org/mail"
icon = "fa fa-envelope"
desc = "Discuss development issues around the project"
91 changes: 91 additions & 0 deletions site/content/en/_index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
+++
title = "CVAT"
linkTitle = "CVAT"

+++


{{< blocks/cover title="Computer Vision Annotation Tool (CVAT)" image_anchor="top" height="full" color="orange" >}}
<div class="mx-auto">
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="{{< relref "/docs" >}}">
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-primary mr-3 mb-4" href="https://github.com/openvinotoolkit/cvat">
Source <i class="fab fa-github ml-2 "></i>
</a>
<p class="lead mt-5">CVAT slogan!</p>
{{< blocks/link-down color="info" >}}
</div>
{{< /blocks/cover >}}


{{< blocks/section color="primary" >}}


{{% blocks/feature icon="fa-server" title="Working on a cluster of servers" %}}
CVAT is a ready-made business solution with the ability to install on a cluster of servers
{{% /blocks/feature %}}


{{% blocks/feature icon="fa-file-code" title="Many formats for export and import annotation " url="/docs/#supported-annotation-formats" %}}
A large number of formats for import and export markings.
{{% /blocks/feature %}}


{{% blocks/feature icon="fa-brain" title="AI annotation tools" %}}
CVAT has many tools for annotation including AI tools
{{% /blocks/feature %}}


{{< /blocks/section >}}


{{% blocks/lead color="dark" %}}

![CVAT demo](/images/demo-page.png)

This is an online demo with the latest version of the annotation tool. Try it online without local installation. Only own or assigned tasks are visible to users.

<div class="mx-auto">
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://cvat.org">
Try it now <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
</div>
{{% /blocks/lead %}}


{{< blocks/section >}}

<div class="col">
<h1 class="text-center">This is the second Section</h1>
</div>

{{< /blocks/section >}}


{{< blocks/section >}}
{{% blocks/feature icon="fab fa-stack-overflow" title="StackOverflow" url="https://stackoverflow.com/search?q=%23cvat" %}}
Tag on StackOverflow *
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/openvinotoolkit/cvat" %}}
We do a [Pull Request](https://github.com/openvinotoolkit/cvat/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-gitter" title="Follow us on Gitter!" url="https://gitter.im/opencv-cvat/public" %}}
For announcement of latest features etc.
{{% /blocks/feature %}}


{{< /blocks/section >}}


{{< blocks/section >}}

<div class="col-12">
<h1 class="text-center">This is another Section</h1>
</div>

{{< /blocks/section >}}
20 changes: 20 additions & 0 deletions site/content/en/about/_index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: About CVAT
linkTitle: About
menu:
main:
weight: 50
---


{{< blocks/cover image_anchor="bottom" height="full" color="info" >}}


<div class="image-wrapper" margin: 0 auto 20px>
<img src="/images/logo2.png">
</div>


CVAT is completely re-designed and re-implemented version of Video Annotation Tool from Irvine, California tool. It is free, online, interactive video and image annotation tool for computer vision. It is being used by our team to annotate million of objects with different properties. Many UI and UX decisions are based on feedbacks from professional data annotation team.

{{< /blocks/cover >}}
1 change: 1 addition & 0 deletions site/content/en/debug.log
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[0316/104620.328:ERROR:registration_protocol_win.cc(130)] TransactNamedPipe: The pipe has been ended. (0x6D)
Loading