Docs: Use mdbook for docs #719
No reviewers
Labels
No labels
Android
CS::needs customer feedback
CS::needs follow up
CS::needs on prem installation
CS::waiting
Chrome
Design:: Ready
Design:: in progress
Design::UX
E2EE
Edge
Firefox
GDPR
Iteration 13 IM
Linux
MacOS
Need::Discussion
Need::Steps to reproduce
Need::Upstream fix
Needs:: Planning
Needs::Dev-Team
Needs::More information
Needs::Priority
Needs::Product
Needs::Refinement
Needs::Severity
Priority::1-Critical
Priority::2-Max
Priority::3-Impending
Priority::4-High
Priority::5-Medium
Priority::6-Low
Priority::7-None
Progress::Backlog
Progress::Review
Progress::Started
Progress::Testing
Progress::Triage
Progress::Waiting
Reporter::Sentry
Safari
Target::Community
Target::Customer
Target::Internal
Target::PoC
Target::Security
Team:Customer-Success
Team:Design
Team:Infrastructure
Team:Instant-Messaging
Team:Product
Team:Workflows
Type::Bug
Type::Design
Type::Documentation
Type::Feature
Type::Improvement
Type::Support
Type::Tests
Windows
blocked
blocked-by-spec
cla-signed
conduit
contribution::advanced
contribution::easy
contribution::help needed
from::review
iOS
p::ti-tenant
performance
product::triage
proposal
refactor
release-blocker
s: dart_openapi_codegen
s::Famedly-Patient
s::Org-Directory
s::Passport-Generator
s::Requeuest
s:CRM
s:Famedly-App
s:Famedly-Web
s:Fhiroxide
s:Fhiroxide-cli
s:Fhiroxide-client
s:Fhirs
s:Hedwig
s:LISA
s:Matrix-Dart-SDK
s:Role-Manager
s:Synapse
s:User-Directory
s:WFS-Matrix
s:Workflow Engine
s:dtls
s:famedly-error
s:fcm-shared-isolate
s:matrix-api-lite
s:multiple-tab-detector
s:native-imaging
severity::1
severity::2
severity::3
severity::4
technical-debt
voip
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference: Matthias/conduit#719
Loading…
Reference in a new issue
No description provided.
Delete branch "mdbook-docs-preparation"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Lays out the foundation to better docs.
With this MR, the docs now all live in the
docs
directory.In the long term, I would like the docs to be available under the conduit.rs domain.
For now, I've gone with the following route:
master
docs: https://conduit-docs.surge.shnext
docs: https://conduit-docs-next.surge.shThis alleviates the issue of the Markdown docs being from the next branch, while people are encouraged to run the master version.
Closes https://gitlab.com/famedly/conduit/-/issues/153
assigned to @jfowl
added 1 commit
Compare with previous version
added 1 commit
Compare with previous version
changed the description
mentioned in issue #228
added 1 commit
Compare with previous version
added 1 commit
Compare with previous version
added 1 commit
Compare with previous version
mentioned in merge request !273
approved this merge request
@timokoesters I'm happy so far with this MR. It is intended as a foundation for new docs, so while this changes some things, it mostly copies old docs to new locations.
If you deem this MR read to merge, please also merge it to master so that the docs will be deployed to GitLab pages, as the README will then reference them.
unapproved this merge request
I think this should be in the .gitignore
Yep, you're right.
Current plan: Hosting docs on http://conduit.rs/docs/ looks like a good idea, will need CI to deploy there, though.
changed this line in version 7 of the diff
added 1 commit
Compare with previous version
Turns out, this file should not even exist in the first place. Deleted it.
resolved all threads
changed the description
mentioned in merge request !315
added 1 commit
Compare with previous version
marked the checklist item Wait for https://gitlab.com/famedly/conduit/-/merge_requests/301 to be merged. as completed
added 1 commit
Compare with previous version
added 1 commit
Compare with previous version
added 1 commit
ac8bdb1f
- docs: Use mdbook for docsCompare with previous version
added 1 commit
6f67687f
- docs: Use mdbook for docsCompare with previous version
added 81 commits
next
e13b435a
- docs: Use mdbook for docsCompare with previous version
changed the description
added 1 commit
90b764be
- docs: Use mdbook for docsCompare with previous version
I rebased on
next
and changed the hosting (for now).A preview for this branch can be found at https://conduit-docs-mdbook-docs-preparation.surge.sh/
This is intended as the base for further doc improvements, so please only judge what's there and not what is missing.
If Timo is happy with this, he might merge it at his own will.
added 1 commit
2449b5cd
- docs: Use mdbook for docsCompare with previous version
added 1 commit
54f13aa9
- docs: Use mdbook for docsCompare with previous version
added 63 commits
next
70b6890e
- docs: Use mdbook for docsCompare with previous version
changed the description
assigned to @timokoesters and unassigned @jfowl
View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.Merge
Merge the changes and update on Forgejo.