Matthias/conduit
1
0
Fork 0
Code Issues 179 Pull requests 44 Projects Releases 5 Packages Wiki Activity

Docs: Use mdbook for docs #719

Open
jfowl wants to merge 1 commit from mdbook-docs-preparation into next
pull from: mdbook-docs-preparation
merge into: Matthias:next
Conversation 37 Commits 1 Files changed 14 +342 -162
jfowl commented 2022-02-06 16:50:42 +00:00 (Migrated from gitlab.com)
Copy link

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:

This 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

  • I agree to release my code and all other changes of this MR under the Apache-2.0 license
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.sh - `next` docs: https://conduit-docs-next.surge.sh - MR docs like this: https://conduit-docs-mdbook-docs-preparation.surge.sh This 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 - [x] I agree to release my code and all other changes of this MR under the Apache-2.0 license
jfowl commented 2022-02-06 16:50:42 +00:00 (Migrated from gitlab.com)
Copy link

assigned to @jfowl

assigned to @jfowl
jfowl commented 2022-02-06 16:51:27 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

  • da625d92 - docs: Use mdbook for docs

Compare with previous version

added 1 commit <ul><li>da625d92 - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=325724664&start_sha=3e08ef40ec38879488fcd6ec6a1cdce14b6a547f)
jfowl commented 2022-02-06 16:53:02 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

  • afd89307 - docs: Use mdbook for docs

Compare with previous version

added 1 commit <ul><li>afd89307 - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=325724868&start_sha=da625d928e6185ace49fd69213f9d3f1943aad8d)
jfowl commented 2022-02-06 17:04:08 +00:00 (Migrated from gitlab.com)
Copy link

changed the description

changed the description
jfowl commented 2022-02-06 20:08:22 +00:00 (Migrated from gitlab.com)
Copy link

mentioned in issue #228

mentioned in issue #228
jfowl commented 2022-02-06 23:30:20 +00:00 (Migrated from gitlab.com)
Copy link
  • @jfowl: Fix cross-reference
- [x] @jfowl: Fix cross-reference
jfowl commented 2022-02-07 11:28:02 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

  • f2a3ff25 - docs: Use mdbook for docs

Compare with previous version

added 1 commit <ul><li>f2a3ff25 - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=326111403&start_sha=afd89307a4282660803115dc5bf1bb8ae48c95c3)
jfowl commented 2022-02-07 11:29:32 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

  • c192493a - docs: Use mdbook for docs

Compare with previous version

added 1 commit <ul><li>c192493a - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=326113083&start_sha=f2a3ff25215b66af826c8714d9d52c2894ef225e)
jfowl commented 2022-02-07 11:50:43 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

  • 35ed3284 - docs: Use mdbook for docs

Compare with previous version

added 1 commit <ul><li>35ed3284 - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=326133108&start_sha=c192493a6c98123fba077a706598460d18044708)
jfowl commented 2022-02-08 09:20:06 +00:00 (Migrated from gitlab.com)
Copy link

mentioned in merge request !273

mentioned in merge request !273
jfowl commented 2022-02-08 10:05:49 +00:00 (Migrated from gitlab.com)
Copy link

approved this merge request

approved this merge request
jfowl commented 2022-02-08 10:08:18 +00:00 (Migrated from gitlab.com)
Copy link

@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.

@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.
jfowl commented 2022-02-08 10:26:17 +00:00 (Migrated from gitlab.com)
Copy link

unapproved this merge request

unapproved this merge request
timokoesters commented 2022-02-12 08:39:56 +00:00 (Migrated from gitlab.com)
Copy link

I think this should be in the .gitignore

I think this should be in the .gitignore
jfowl commented 2022-02-12 18:56:23 +00:00 (Migrated from gitlab.com)
Copy link

Yep, you're right.

Yep, you're right.
jfowl commented 2022-02-15 10:00:45 +00:00 (Migrated from gitlab.com)
Copy link

Current plan: Hosting docs on http://conduit.rs/docs/ looks like a good idea, will need CI to deploy there, though.

Current plan: Hosting docs on http://conduit.rs/docs/<version> looks like a good idea, will need CI to deploy there, though.
jfowl commented 2022-02-15 10:02:08 +00:00 (Migrated from gitlab.com)
Copy link

changed this line in version 7 of the diff

changed this line in [version 7 of the diff](/famedly/conduit/-/merge_requests/294/diffs?diff_id=331863492&start_sha=35ed3284874036a7cac7091c8c09e78c6688e971#f6013a00b362253c64368d6eebc50ea2131754e2_4_0)
jfowl commented 2022-02-15 10:02:09 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

  • 88722e65 - docs: Use mdbook for docs

Compare with previous version

added 1 commit <ul><li>88722e65 - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=331863492&start_sha=35ed3284874036a7cac7091c8c09e78c6688e971)
jfowl commented 2022-02-15 10:02:43 +00:00 (Migrated from gitlab.com)
Copy link

Turns out, this file should not even exist in the first place. Deleted it.

Turns out, this file should not even exist in the first place. Deleted it.
jfowl commented 2022-02-15 10:02:45 +00:00 (Migrated from gitlab.com)
Copy link

resolved all threads

resolved all threads
jfowl commented 2022-02-16 14:23:34 +00:00 (Migrated from gitlab.com)
Copy link

changed the description

changed the description
jfowl commented 2022-02-20 10:14:07 +00:00 (Migrated from gitlab.com)
Copy link

mentioned in merge request !315

mentioned in merge request !315
jfowl commented 2022-02-22 18:53:18 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

  • fad6eed5 - docs: Use mdbook for docs

Compare with previous version

added 1 commit <ul><li>fad6eed5 - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=337344485&start_sha=88722e65b32d93baa2c606a9a0c5b072908af21d)
jfowl commented 2022-02-22 18:53:23 +00:00 (Migrated from gitlab.com)
Copy link

marked the checklist item Wait for https://gitlab.com/famedly/conduit/-/merge_requests/301 to be merged. as completed

marked the checklist item **Wait for https://gitlab.com/famedly/conduit/-/merge_requests/301 to be merged.** as completed
jfowl commented 2022-02-22 18:54:48 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

  • 2e232094 - docs: Use mdbook for docs

Compare with previous version

added 1 commit <ul><li>2e232094 - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=337345256&start_sha=fad6eed5a432156362492e3633a969541087493f)
jfowl commented 2022-02-22 18:56:21 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

  • 3d2505cd - docs: Use mdbook for docs

Compare with previous version

added 1 commit <ul><li>3d2505cd - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=337346234&start_sha=2e2320944a58bee9e01dc5cf9661e53e6c753c87)
jfowl commented 2022-02-22 18:57:23 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

Compare with previous version

added 1 commit <ul><li>ac8bdb1f - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=337346858&start_sha=3d2505cdce08a5a2a8343c730d53c816a1bef621)
jfowl commented 2022-02-22 19:12:27 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

Compare with previous version

added 1 commit <ul><li>6f67687f - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=337355658&start_sha=ac8bdb1f2de1589974f56c283c98c6a5140851fe)
jfowl commented 2022-02-22 19:32:10 +00:00 (Migrated from gitlab.com)
Copy link

added 81 commits

  • 6f67687f...6788225c - 80 commits from branch next
  • e13b435a - docs: Use mdbook for docs

Compare with previous version

added 81 commits <ul><li>6f67687f...6788225c - 80 commits from branch <code>next</code></li><li>e13b435a - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=337368891&start_sha=6f67687f470cb18386ba0d0b1e451677b1e78b78)
jfowl commented 2022-02-22 19:42:40 +00:00 (Migrated from gitlab.com)
Copy link

changed the description

changed the description
jfowl commented 2022-02-22 19:48:17 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

Compare with previous version

added 1 commit <ul><li>90b764be - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=337377464&start_sha=e13b435ad163ed9e0e0b4d7585021f5294baf11f)
jfowl commented 2022-02-22 19:52:10 +00:00 (Migrated from gitlab.com)
Copy link

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.

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.
jfowl commented 2022-02-23 10:15:34 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

Compare with previous version

added 1 commit <ul><li>2449b5cd - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=337778182&start_sha=90b764bec53c3ba0c26e87be218761703bab0793)
jfowl commented 2022-03-26 09:43:31 +00:00 (Migrated from gitlab.com)
Copy link

added 1 commit

Compare with previous version

added 1 commit <ul><li>54f13aa9 - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=360065255&start_sha=2449b5cdc7e2d89fe211a006f5992986259ae458)
jfowl commented 2022-04-09 10:59:48 +00:00 (Migrated from gitlab.com)
Copy link

added 63 commits

  • 54f13aa9...6e106b57 - 62 commits from branch next
  • 70b6890e - docs: Use mdbook for docs

Compare with previous version

added 63 commits <ul><li>54f13aa9...6e106b57 - 62 commits from branch <code>next</code></li><li>70b6890e - docs: Use mdbook for docs</li></ul> [Compare with previous version](/famedly/conduit/-/merge_requests/294/diffs?diff_id=370309451&start_sha=54f13aa9cc09e4f810fe4fe8a2c2e4fa12911c4e)
jfowl commented 2022-04-09 11:06:34 +00:00 (Migrated from gitlab.com)
Copy link

changed the description

changed the description
timokoesters commented 2022-11-27 20:27:26 +00:00 (Migrated from gitlab.com)
Copy link

assigned to @timokoesters and unassigned @jfowl

assigned to @timokoesters and unassigned @jfowl
This pull request has changes conflicting with the target branch.
  • .gitlab-ci.yml
  • DEPLOY.md
  • README.md
  • docker/README.md
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin mdbook-docs-preparation:mdbook-docs-preparation
git checkout mdbook-docs-preparation

Merge

Merge the changes and update on Forgejo.
git checkout next
git merge --no-ff mdbook-docs-preparation
git checkout next
git merge --ff-only mdbook-docs-preparation
git checkout mdbook-docs-preparation
git rebase next
git checkout next
git merge --no-ff mdbook-docs-preparation
git checkout next
git merge --squash mdbook-docs-preparation
git checkout next
git merge --ff-only mdbook-docs-preparation
git checkout next
git merge mdbook-docs-preparation
git push origin next
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
Android

This label indicates that the issue affects Android devices.

  
CS::needs customer feedback

Issue has been finished and needs feedback from the customer if everything is okay OR the customer needs to answer questions before issue can be worked on.

  
CS::needs follow up

We have received questions or new information from the customer that needs discussing in the meeting with Product and Sales

  
CS::needs on prem installation

This Issue needs to be installed on prem at the customer after closing

  
CS::waiting

This Issue is in progress in other teams (prod/tech)

  
Chrome

This label indicates that the issue affects the chrome browser. You should always combine it with other platforms like Android, if it only affects Android.

  
Design:: Ready

   
Design:: in progress

   
Design::UX

@Famedly: Do not use this label

  
E2EE

   
Edge

This label indicates that the issue affects Edge devices.

  
Firefox

This label indicates that the issue affects Firefox devices.

  
GDPR

   
Iteration 13 IM

   
Linux

This label indicates that the issue affects Linux devices.

  
MacOS

This label indicates that the issue affects MacOS devices.

  
Need::Discussion

Topic needs more discussion

  
Need::Steps to reproduce

   
Need::Upstream fix

   
Needs:: Planning

   
Needs::Dev-Team

This label indicates that the issue needs to be assigned to a dev team.

  
Needs::More information

   
Needs::Priority

This label should be set if there is no priority on feature or improvement requests.

  
Needs::Product

   
Needs::Refinement

the issue is triaged and needs to go to the refinement meeting to be able to set story points to the issue

  
Needs::Severity

This label should be set if bug reports need a severity.

  
Priority::1-Critical

The Priority 1 label indicates a critically dire issue such as a regression, or failure in existing features. We look at issues with this label frequently. If you find yourself assigning a Prio 1 label to an issue, please be sure that there's a positive handoff between filing and a prospective owner for the issue. Prio 1 issues should be rare. Normally there should be zero open P1 issues. "The world is on fire."

  
Priority::2-Max

The Priority 2 label indicates that the issue deserves immediate attention, such as affecting a top-tier customer. There are generally only one or two Prio 2 bugs at a time, and we aim for there to be none. "A customer is on fire."

  
Priority::3-Impending

A bug with Priority 3 flag indicates that a top-tier customer is about to encounter this bug. Generally, there are less than ten Priority 3 bugs. Issues may not be handled immediately (sometimes some Prio 4 issues are handled first), but are top-of-mind and we explicitly consider them weekly. "A customer is about to be on fire."

  
Priority::4-High

The Priority 4 label indicates high-priority issues that are at the top of the work list. This is the highest priority level an issue can have if it isn't affecting a top-tier customer or breaking the app. Bugs marked Priority 4 are generally actively being worked on unless the assignee is dealing with a P1-P3 bug(or another P4 issue).

  
Priority::5-Medium

The Priority 5 label indicates issues that we agree are important to work on, but not at the top of the work list. This is the default level for a bug. An issue at this priority level may not be worked on for a long time. Often an issue at this level will first migrate to Prio 4 before we work on them.

  
Priority::6-Low

The Priority 6 label indicates issues we think are valid but not important. This is the default level for new feature requests. We are unlikely to work on such issues unless they form part of a long-term strategic plan (see the Roadmap).

  
Priority::7-None

The Priority 7 label indicates valid issues that are unlikely to ever be worked on. We use "thumbs-up" on these issues to promote them to Priority 6 or higher based on demand.

  
Progress::Backlog

The Refinement of the issue is completed and DoR for the Squad is fulfilled

  
Progress::Review

Merge Request is ready for review. By definition MR review needs to be done by a second developer.

  
Progress::Started

The issue has been picked up for work by a developer in the team and the developer started to work on actively on the issue.

  
Progress::Testing

In testing

  
Progress::Triage

This is the first step of the process. Issue has been recently opened. Product team will identify/evaluate the following: - Clarify questions if required / verify DoR for Product is met. - It’s been identified if Design work is required or not. - Technical Feasibility - Components involved. - Team to work on that issue. - Severity (in case the issue refers to a bug)

  
Progress::Waiting

A blocker has been identified and work cannot continue.

  
Reporter::Sentry

   
Safari

This label indicates that the issue affects Safari devices.

  
Target::Community

   
Target::Customer

   
Target::Internal

   
Target::PoC

Proof of Concept - issues necessary for potential customer acquisition. Can be scoped by deadline for planned presentations

  
Target::Security

   
Team:Customer-Success

   
Team:Design

Issues which are in the competence area of the frontend chapter. It is not a scoped label anymore as issues can be part of different chapters. Before we can start implementing/changing this, we need a UI/UX design first.

  
Team:Infrastructure

Issues which are in the competence area of the infrastructure chapter. It is not a scoped label anymore as issues can be part of different chapters.

  
Team:Instant-Messaging

   
Team:Product

Issues which are in the responsibility of the product team.

  
Team:Workflows

   
Type::Bug

A software bug is an error, flaw or fault in a computer program or system that causes it to produce an incorrect or unexpected result, or to behave in unintended ways.

  
Type::Design

A task about creating or improving the UI/UX design

  
Type::Documentation

   
Type::Feature

Nothing broken; Request for a new feature.

  
Type::Improvement

An improvement or enhancement to an existing feature, technically solution or code. It makes a working functionality faster, more secure, add some additional value, refactors code etc. or helps to design a better UX and UI.

  
Type::Support

   
Type::Tests

A task about writing or improving automated or manual tests.

  
Windows

This label indicates that the issue affects Windows devices.

  
blocked

   
blocked-by-spec

   
cla-signed

   
conduit

   
contribution::advanced

   
contribution::easy

Easy task to start with a contribution

  
contribution::help needed

   
from::review

Reported by famedly review

  
iOS

This label indicates that the issue affects iOS devices.

  
p::ti-tenant

This label indicates that the issues is a requirement of the ti-tenant

  
performance

   
product::triage

   
proposal

A feature propsal.

  
refactor

   
release-blocker

This issue needs to be fixed before the next release.

  
s: dart_openapi_codegen

   
s::Famedly-Patient

Service: Famedly-Patient App

  
s::Org-Directory

For issues that relate to the organisation directory https://gitlab.com/famedly/company/backend/services/organisation-directory/

  
s::Passport-Generator

Service: PASSporT-Generator

  
s::Requeuest

For anything relevant to the requeuest library

  
s:CRM

Service: CRM

  
s:Famedly-App

Service: Famedly-App

  
s:Famedly-Web

Service: Famedly-Web

  
s:Fhiroxide

Service: Fhiroxide

  
s:Fhiroxide-cli

Fhir(oxide) maintenance and debug CLI

  
s:Fhiroxide-client

Fhiroxide client library

  
s:Fhirs

Service: FHIRS

  
s:Hedwig

Service: Hedwig

  
s:LISA

Service: LISA

  
s:Matrix-Dart-SDK

Service: Matrix-Dart-SDK

  
s:Role-Manager

Service: Role-Manager

  
s:Synapse

Service: Synapse

  
s:User-Directory

Service: User-Directory

  
s:WFS-Matrix

Service: Workflow-Service-Matrix

  
s:Workflow Engine

Service: Workflow-Engine

  
s:dtls

   
s:famedly-error

   
s:fcm-shared-isolate

   
s:matrix-api-lite

   
s:multiple-tab-detector

   
s:native-imaging

   
severity::1

Blocker: Broken feature with no workaround or any data-loss. It makes the feature unusable!

  
severity::2

Critical: Broken feature with an unacceptably complex workaround.

  
severity::3

Major: Broken feature with a workaround.

  
severity::4

Low: Functionality is inconvenient.

  
technical-debt

This Issue is a technical debt. Mark issues with this label to have an overview of the technical debts in a repository or group.

  
voip
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
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Matthias/conduit#719
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?