7 Commits

Author SHA1 Message Date
Ron Stone
87cf79ba4c Shorten long file names (r8, r7, r6, r5)
https://review.opendev.org/c/starlingx/docs/+/893405 revealed
a problem with very long file names not being linkable in some
browsing contexts. The problem was corrected by shortening
the filename to 75 chars + extension. This review checks for
and trims long filename input to 'tox -e newfile' to 75 chars
+ extension. (62 + dash + UUID fragment)

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Id6fa734c664977606649ff38d7e837fd1f91d178
2023-09-01 12:20:59 +00:00
Ron Stone
090becd41e Consolidate utils (r8,4 r7, r6, r5)
Many bash functions are duplicated across scripts. This commit
consolidates them on one file for more efficient managment.

Some incidental updates were made:
- set default start date in pickCompare to today-9 months instead of 2020-01-01.
  This reduces clutter when selecting authors and stale gerrits in output.
- fix a routine used by normalize-includes

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ifd64e38fbe4324c7d6b4eccb725ef3d8367f6578
2023-07-26 18:05:59 +00:00
Ron Stone
cbc5d16a11 Constrain label char set (r6,r5)
Some characters in rST labels are not handled correctly by XSLT
post-processors.
This change fixes two known instances and modifies the newfile
tox job to handle these chars.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I535362dc40de6796b795b2ac86ef46a1edec685c
2022-03-14 08:01:49 -04:00
Ron Stone
0c557fab23 Modify new file name rules (pick r6 & r5)
Double dashes in filenames can cause post-processing to fail
in some circumstances. This change converts double dashes to
single.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I46be137ad9393548015a455f29f188a13e4627f1
2022-02-22 12:58:43 +00:00
Ron Stone
4cdf447ece Extent usage of UUID filenames
Extend newfile script to generate unique filenames for
include files.
Update instructions in Contributor guide
Include correct version of new-topic.sh
Fix script output in Contributor guide

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I049adb2a8b8b028c45e2fc4f951db664e4777550
2021-12-23 07:36:17 -05:00
Ron Stone
9684d8f766 Convert file name to lower case
uuidgen produced upper case uuids on some platforms (macOS). Changed
timing of filename lowercasing to catch this.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I4ffe8d3c0e2f272433b59d5c942bc8bdf4fc806c
2021-10-01 06:43:05 -04:00
Ron Stone
89c8aeaca5 Unique rST file names
As discussed, a simple script to create stubs with unique names and labels.
Prefix name of index files with "index-" to distinguish them from 'regular'
files.
Added missing "::" to templated rubrics.
Remove unneeded echo.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I8f7dd8f4a57655032de6913d4570f5ca5c2b9338
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-09-29 07:49:00 -04:00