-
Notifications
You must be signed in to change notification settings - Fork 9
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
Migrate wiki to MkDocs #102
Conversation
fb6d4e7
to
d54ec6d
Compare
@seancolsen I fixed wiki call out boxes in b399be9 (was pretty quick using regex). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@seancolsen This looks great, thanks for moving this forward. I made a commit to fix wiki call outs and commented in the main PR.
Feedback:
(1) Please add redirects for the pages in https://wiki.mathesar.org/en/engineering/reports so the URLs still resolve. The GSoC website links to these reports, so we want them to work. Maybe also add a comment explaining this so if we ever clean up redirects in the future, we know not to delete these.
(2) Can we use the same extra stylesheet we use for the main docs (docs.mathesar.org) here? Dark mode with the default stylesheet is really hard to read.
Replaced `:[a-z_]+:\s+` with ``
Replace `^---\ntitle: ([^\n]+)\n((?!\n---)[\s\S])+\n---` with `# $1`
Replace `\]\(/en([^)]*)\)` with `](/$1)`
Found via `\]\((?!(https?:|\.|/|#|\)|mailto:))`
- Identified via `^#\s((?!\n##)[\s\S])+\n#\s` - Fixed manually
Replace `^(\s*[^\s\-#\n].*\n)-` with `$1\n-` Plus, some post-processing manual cleanup
Identified via `^(\s*[^\s\*#\n].*\n)\*\s` Cleaned manually
Identified via: ``` git diff --name-status 72049f5 > ~/tmp/git-status.tsv ``` Plus, some data massaging via spreadsheet.
@kgodey this is ready for re-review now.
DeploymentIf you approve of this PR, I wonder how risky you think it might be to merge it into |
@seancolsen This looks good!
I agree.
I don't think we need a comment now that the redirects are so comprehensive, the comment I was envisioning was to explain why we were redirecting only specific pages (and I figured it would be in
I think we need to disable the git storage mechanism in Wiki.js (docs: https://docs.requarks.io/storage/git) before we merge this PR, otherwise it will attempt to reconcile the content and make updates to the wiki. Once that's handled, it's fine to merge it in and leave the wiki site stale while you figure out deployment. I assume you'll update the dev mailing list email thread once it's merged. |
Related to mathesar-foundation/mathesar#3079
Changes handled in this PR
Changes NOT handled in this PR
Fix wiki call-out box content using{.is-info}
{.is-danger}
{.is-warning}
(Now done by Kriti)
GitHub actions for auto deployment
How to review
README.md
and run through the steps to "Preview your edits locally"