Recommend storing images like any other artifact: in a hierarchical
manner, without "images" subfolders.
This is intended to avoid dangling artifacts when projects are moved,
renamed, or deleted.
Recommend overwriting the page title with a shorter title in the
toctree, so the navigation bar doesn't overflow or get too cluttered.
Add acostina to CODEOWNERS
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Drop part role, use generic adi instead for root adi domain links.
For future reference, the snipped used was:
find ./docs/projects -type f -exec sed -i 's/:part:/:adi:/g' {} \;
Drop Containerfile.
Add option to validate links status (e.g. 200, 404), intended mostly for CI
use to check if a page has disappeared from the internet.
Validate links uses coroutines to launch multiple tasks concurrently,
but do it in bundles to avoid being rate limited.
Fixup regmap styling.
Add imoldovan, jmarques, spop, lbarbosa as docs codeowners.
Remove branch field for links to the hdl repo.
Change git role to display full path.
Fixup ZedBoard link label, remove IP List, add SYSID_ROM dokuwiki link
in ad716_sdz project.
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Add files CODEOWNERS, filled with owners per each hdl project and some IPs.
Specific code owners will be automatically added as reviewers, whenever new
PRs are opened, depending on affected folders/files from repo.
CODEOWNERS file can be different on each branch.
PULL_REQUEST_TEMPLATE.md content will populate all new PR description field.
Beside PR description, it contains a list of checkboxes, ensuring all
team members follow the same guidelines and enforce best practices.
PR Template applies for PRs against repository's default branch.
Both files were added in .github
Signed-off-by: Stefan Raus <Stefan.Raus@analog.com>
* Added copyright and license header
* Updated files on which it runs on
* SystemVerilog not to be supported, since now there are some pkg files
that do not have the format of a Verilog file, thus making the
checker to fail all the time -- which is not good
* Now it can run on files which contain JESD in their paths, because
now all of them have the copyright on the same line (but the
copyright inside the JESD license can't be checked yet by the script)
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
* Updated the versions for repos and this solved the deprecated command
issue
* Changed the end message for when the guideline is not followed
Signed-off-by: Iulia Moldovan <Iulia.Moldovan@analog.com>
Added readme_check_guideline.md along with the check_guideline.py
to explain the usage of this and to show how it should be used.
Signed-off-by: Iulia Moldovan <iulia.moldovan@analog.com>
* Updated action to run only in PRs on master branch, on library/ and
projects/ paths
* Edited the text for the printed warnings
* Updated the version for the checkout action from v2 to v3
Signed-off-by: Iulia Moldovan <iulia.moldovan@analog.com>
Iulia Moldovan
Jorge Marques
PopPaul2021
Stefan Raus
Robin Getz
István Csomortáni