Our great sponsors
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
-
-
Gitea
Git with a cup of tea! Painless self-hosted all-in-one software development service, including Git hosting, code review, team collaboration, package registry and CI/CD
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
-
-
-
-
Joplin
Joplin - the secure note taking and to-do app with synchronisation capabilities for Windows, macOS, Linux, Android and iOS.
-
SaaSHub
SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives
GitLab team member here, thanks for sharing!
I'm using the Web IDE to take notes in most of my projects, work and personal, and publish the notes with MkDocs and GitLab Pages to a searchable frontend/domain when needed. Editing also happens in Gitpod with live preview in the browser.
You can find all resources for o11y.love [0] and opsindev.news [1] in the GitLab projects, including .gitpod.yml configuration, mkdocs.yml setup, .gitlab-ci.yml deployments.
I have been writing lots of documentation in my past OSS projects, so I am used to Markdown as markup language, taking notes very fast. Learning Markdown requires some practice, and can be helped within Gitpod and the VS Code extensions, if the default preview is not sufficient. [2] [3] You can also sync the notes repository offline into VS Code as desktop IDE for example.
Using Obsidian.md to take notes and publish with GitLab pages [4] looks promising too; I have not tried it yet.
[0] https://gitlab.com/everyonecancontribute/observability/o11y....
[1] https://gitlab.com/dnsmichi/opsindev.news
[2] https://www.gitpod.io/docs/ides-and-editors/vscode-extension...
[3] https://code.visualstudio.com/docs/languages/markdown
[4] https://about.gitlab.com/blog/2022/03/15/publishing-obsidian...
GitLab team member here, thanks for sharing your experience!
The UX with editing the wiki, using WYSIWYG content editor [0] has been improved in recent releases. [1] I peeked into 15.2 (self-managed release coming on Friday, July 22) which brings rendering Mermaid, PlantUML, Kroki diagrams previews. [2]
Maybe the wiki can be worth to revisit in the future, there are more features underway, suggest diving into this epic [3]
> Issues have the same markdown support, we can use ctrl+v to insert screenshots, we can add tags to the issues, we can assign people to relevant issues, we can comment with new things to do/add, and we can use the search bar to find relevant content. All our "knowledge doc" is stored insides the issues of an empty project named "doc".
Great to see that you have found a workflow, and use issues to keep things documented and organized. Maybe a suggestion for creating an entry point into the dcc project: Use GitLab CI/CD to read the issues from the REST API, group by label, and render a Markdown README.md file which gets pushed to the repository automatically. That way the "index" is generated and provides greater visibility into the documentation issues.
I like API challenges, so I've hacked [4] a small script [5] using python-gitlab to better illustrate what I mean :-) Uses issues [6] with labels to generate an index.md [7] (can also be README.md for example).
Feel free to repurpose for your own needs, if that helps. The missing step is to automate it using GitLab CI/CD Schedules, but that's documented.
[0] https://docs.gitlab.com/ee/user/project/wiki/#content-editor
[1] https://about.gitlab.com/releases/2022/05/22/gitlab-15-0-rel...
[2] https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86701
[3] https://gitlab.com/groups/gitlab-org/-/epics/5401
[4] https://gitlab.com/dnsmichi/api-playground/-/merge_requests/...
[5] https://gitlab.com/dnsmichi/api-playground/-/tree/main/pytho...
[6] https://gitlab.com/dnsmichi/api-playground/-/issues
[7] https://gitlab.com/dnsmichi/api-playground/-/blob/main/index...
Depending on which particular subject you are interested in:
- The plugin:
https://wielder.victor.earth/Welcome shows the sort of things you can build with Wielder. The github repository for the library is here https://github.com/victorb/obsidian-wielder
- How To Solve it
The key ideas behind How To Solve It are that for a lot of our challenges there are strategies we can use to tackle them effectively. How To Solve It expounds on how to go about understanding a problem, understanding the connection of the data you have with what you don't know, how to make problems more tractable, carrying out a plan, and evaluating the results.
- Untools
A site dedicated to listing various strategies for thinking, communicating and prioritization; they sell templates similar in nature to what I'm building, but I depart sharply from them in my desired document representation choice for templates - Zettlekastian graph continuations for me versus linear documents for them.
- My own tool
This is currently private and not yet ready for public consumption. I have a whole lot of philosophical backing for what I'm trying to build but it is still very far from generating utility at the level I want it too. Later today I'll see about moving some private notes into a blog post going into more depth about what I'm building and why.
Step 3: Start using ... you can add sub-directories with Markdown for notes ... you can add all the file types above.
For Gitlab just click "Web IDE" from your project's homepage.
(I made this URL: https://github.dev/{{username}}/{{repo-name}} my homepage, making it super easy to access.)
This is absolutely nothing new; but the epiphany I had a week or so ago but using a repo in this way seems to have really stuck (yes, a week is a short period of time but often a note app or approach sticks for a day or 2 for me).
I'm really curious if others do something like this & what other sorts of practices they might employ while doing this.
There are some hints as to how to do this with Gitea in this issue[0].
Unfortunately, it doesn't seem very easy to do w/o running a CI task or something like that.
[0] https://github.com/go-gitea/gitea/issues/302
GitLab team member here, thanks for sharing!
I'm using the Web IDE to take notes in most of my projects, work and personal, and publish the notes with MkDocs and GitLab Pages to a searchable frontend/domain when needed. Editing also happens in Gitpod with live preview in the browser.
You can find all resources for o11y.love [0] and opsindev.news [1] in the GitLab projects, including .gitpod.yml configuration, mkdocs.yml setup, .gitlab-ci.yml deployments.
I have been writing lots of documentation in my past OSS projects, so I am used to Markdown as markup language, taking notes very fast. Learning Markdown requires some practice, and can be helped within Gitpod and the VS Code extensions, if the default preview is not sufficient. [2] [3] You can also sync the notes repository offline into VS Code as desktop IDE for example.
Using Obsidian.md to take notes and publish with GitLab pages [4] looks promising too; I have not tried it yet.
[0] https://gitlab.com/everyonecancontribute/observability/o11y....
[1] https://gitlab.com/dnsmichi/opsindev.news
[2] https://www.gitpod.io/docs/ides-and-editors/vscode-extension...
[3] https://code.visualstudio.com/docs/languages/markdown
[4] https://about.gitlab.com/blog/2022/03/15/publishing-obsidian...
So, there's "todo.txt-cli"† that can help manage todo files in a more task-orientated fashion, while still just using text files. As a bonus, it got something of a cult following a few years back, and there are apps for both mobile platforms which can interact with them too (even out of dropbox, iirc).
† https://github.com/todotxt/todo.txt-cli
Personally, I use Obsidian.md [1] to take notes, especially because there is an extension for excalidraw [2] that I particularly like.
To publish my notes, I use PineDocs [3] which generates a very nice website with the markdown files
[1] https://obsidian.md/
Recently I've been using joplin [0] has mobile and desktop apps and uses a number of cloud storage to sync.
[0] https://joplinapp.org/
Not the author, but I also use VSCode and installed "TodoMD" for my tasks. Highly recommend! https://github.com/usernamehw/vscode-todo-md
Yes!
I keep a daily log tracked in git. All of it public although some information is encrypted with my privatization tool (https://github.com/higgins/privatize).
The log itself is a simple org file but I parse and render it in html here so that I can share important event dates (eg: my wedding) with my family and friends.
Here is what I did yesterday:
GitLab team member here, thanks for sharing your experience!
The UX with editing the wiki, using WYSIWYG content editor [0] has been improved in recent releases. [1] I peeked into 15.2 (self-managed release coming on Friday, July 22) which brings rendering Mermaid, PlantUML, Kroki diagrams previews. [2]
Maybe the wiki can be worth to revisit in the future, there are more features underway, suggest diving into this epic [3]
> Issues have the same markdown support, we can use ctrl+v to insert screenshots, we can add tags to the issues, we can assign people to relevant issues, we can comment with new things to do/add, and we can use the search bar to find relevant content. All our "knowledge doc" is stored insides the issues of an empty project named "doc".
Great to see that you have found a workflow, and use issues to keep things documented and organized. Maybe a suggestion for creating an entry point into the dcc project: Use GitLab CI/CD to read the issues from the REST API, group by label, and render a Markdown README.md file which gets pushed to the repository automatically. That way the "index" is generated and provides greater visibility into the documentation issues.
I like API challenges, so I've hacked [4] a small script [5] using python-gitlab to better illustrate what I mean :-) Uses issues [6] with labels to generate an index.md [7] (can also be README.md for example).
Feel free to repurpose for your own needs, if that helps. The missing step is to automate it using GitLab CI/CD Schedules, but that's documented.
[0] https://docs.gitlab.com/ee/user/project/wiki/#content-editor
[1] https://about.gitlab.com/releases/2022/05/22/gitlab-15-0-rel...
[2] https://gitlab.com/gitlab-org/gitlab/-/merge_requests/86701
[3] https://gitlab.com/groups/gitlab-org/-/epics/5401
[4] https://gitlab.com/dnsmichi/api-playground/-/merge_requests/...
[5] https://gitlab.com/dnsmichi/api-playground/-/tree/main/pytho...
[6] https://gitlab.com/dnsmichi/api-playground/-/issues
[7] https://gitlab.com/dnsmichi/api-playground/-/blob/main/index...
Here's another great template I've been utilizing
https://github.com/Rainbell129/Obsidian-Homepage/releases
I share a folder between my Obsidian vault and the folder PineDocs uses with Syncthing (because the machine that runs PineDocs is not my laptop), so as soon as I save my files the site is immediately updated, but PineDocs was not designed with Obsidian in mind, the links work but not the advanced features Obsidian offers.
On the other hand, Perlite [1] is (I never really tested it but it looks cool) designed with Obsidian in mind so maybe it supports more features.
[1] https://github.com/secure-77/Perlite
I discovered this one not long ago, and I think it would tick most of the boxes for your use case: https://a9.io/voiceliner/.
Related posts
- Using Github to write my notes has helped me retain knowledge immensely.
- A structured note-taking app for personal use
- Ask HN: How did you migrate off Evernote?
- How to place images next to each other
- Obsidian 1.3.6 adds deep linking to PDF selections and annotations (available for early access on desktop)