deploy torspec as HTML to GitLab Pages
https://github.com/torproject/torspec/pull/96 will deploy torspec in HTML to any GitLab fork setup with CI and Pages (default on gitlab.com). it only adds one file: .gitlab-ci.yml
Once merged, the site will show up automatically on https://torproject.gitlab.io/torspec, and it'll sync every commit from the canonical repo and automatically rebuild the HTML.
The sed regexps in .gitlab-ci.yml could be used as the beginnings of a conversion to Markdown format, as needed.
Activity
changed milestone to %Tor: 0.4.3.x-final
Here's a Python version of the same script, for anyone who wants it.
import glob import os import re if not os.path.exists('public'): os.mkdir('public') titles = dict() for f in glob.glob('*.txt'): with open(f) as fp: contents = fp.read() contents = re.sub(r'^\n +', r'# ', contents) contents = re.sub(r'\n {1,3}([^ ])', r'\n\1', contents) contents = re.sub(r'\n([0-9]+\. (?!http))', r'\n## \1', contents) contents = re.sub(r'\n([0-9]+\.[0-9]+\. )', r'\n### \1', contents) contents = re.sub(r'\n([0-9]+\.[0-9]+\.[0-9]+\. )', r'\n#### \1', contents) contents = re.sub(r'\n([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+\. )', r'\n##### \1', contents) with open(f, 'w') as fp: fp.write(contents) m = re.match(r'\s*# (.*)\n', contents) titles[re.sub(r'\.txt$', r'', f)] = m.group(1) with open('public/index.html', 'w') as fp: fp.write('<!DOCTYPE html>\n\n<html><body><h1>%s</h1><ul>' % os.getenv('CI_PROJECT_PATH')) for k, v in sorted(titles.items()): fp.write('<li><a href="%s.html"><tt>%s</tt>: %s</a></li>' % (k, k, v)) fp.write('</ul></body></html>')
I think we should merge this for the following reasons:
- The output is a bit rough in the edges, but we can fix the formatting over time.
- We can extend it to include proposals over time and also fix their formatting over time.
- It will integrate well if/when we move to Gitlab ourselves.
- It's only a single additional file in the repository.
Trac:
Status: needs_review to merge_ready-
The current output is visible here: https://eighthave.gitlab.io/torspec/
-
I only included this preprocessor as a temporary measure to help with migrating to Markdown (or whatever format). I don't think it makes sense to keep it around beyond its use in migrating to Markdown. I think one workable policy here would be to just say all future edits must be Markdown, then the rest of the documents can be migrated as the opportunity arises, either piecemeal or all at once.
moved to tpo/core/tor#32627 (closed)
