Skip to content

doc(spec): deprecate the videos key #352

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.

Sign up for GitHub

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

Open
bfabio wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc(spec): deprecate the videos key #352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 0 additions & 2 deletions docs/standard/example/publiccode.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,6 @@ description:
- img/sshot1.jpg
- img/sshot2.jpg
- img/sshot3.jpg
videos:
- https://youtube.com/xxxxxxxx
awards:
- 1st Price Software of the year

Expand Down
8 changes: 4 additions & 4 deletions docs/standard/schema.core.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,8 +577,8 @@ Screenshots can be of any shape and size; the suggested formats are:
- Tablet: 1024x768 @2x
- Mobile: 375x667 @2x

Key ``description/[lang]/videos``
'''''''''''''''''''''''''''''''''
Key ``description/[lang]/videos`` (*deprecated*)
''''''''''''''''''''''''''''''''''''''''''''''''

- Type: array of strings (URLs)
- Presence: optional
Expand All @@ -591,8 +591,8 @@ hosted on a video sharing website that supports the
`oEmbed <https://oembed.com>`__ standard; popular options are YouTube
and Vimeo.

Since videos are an integral part of the documentation, it is
recommended to publish them with an open license.
This key is deprecated, link videos from the documentation or the
website of the software instead.

Key ``description/[lang]/awards``
'''''''''''''''''''''''''''''''''
Expand Down