Comment by dnsmichi | Hacker News Reader

Comment by dnsmichi | Hacker News Reader

Parent Full thread

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

That's awesome- thanks for sharing!

It's off on a bit of a tangent, but here goes :)

We recently started using Hugo with GitLab pages for our intranet/knowledge base. Our company builds a lot of small tools/sites/applications, and we needed a way to collect the docs from all of our projects to publish on the intranet.

I hacked together a Ruby script to pull all project README.md and /doc and and also inject some metadata at the same time - I shared some details on a recent GitLab blog post: https://about.gitlab.com/blog/2022/05/12/gitlab-heroes-unmas...

The OP method of using issues also gives me a really interesting idea for capturing our "developer discussions" as issues then when the issue is closed, including it in our intranet! Love it!

Wanted to explore your site: https://opsindev.news/, but it's giving SSL error to me.

Thanks for flagging. opsindev.news is hosted on GitLab Pages using Let's Encrypt. Maybe the TLS ciphers or versions do not match. Which error message do you see, browser/OS and location may help (if you want to share)

If the MkDocs website does not work, suggest the following workarounds: Newsletter issues in [0] as markdown files, example [1] or the newsletter archive on Buttondown [2].

I'm using Buttondown to send the newsletter, MkDocs serves as web-searchable archive. Kudos to Michael Hausenblas here for the idea, he publishes the o11y.news newsletter.

[0] https://gitlab.com/dnsmichi/opsindev.news/-/tree/main/docs/a...

[1] https://gitlab.com/dnsmichi/opsindev.news/-/blob/main/docs/a...

[2] https://buttondown.email/opsindev.news/

could it be your local environment blocking the .news TLD, and giving you a redirect?

(for example, Cisco Umbrella (formerly OpenDNS Umbrella))

Reply on news.ycombinator.com