Skip to content

Commit a54ce77

Browse files
authored
Update index.md
1 parent 07aa71d commit a54ce77

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

index.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,31 @@ title: Home
33
layout: home
44
---
55

6-
This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details.
6+
# 🗣️ Samtale
7+
###### A sandbox project by [OS2](https://www.os2.eu/)
8+
_Empowering organizations and authorities to collaborate effectively through focused discussions._
9+
###### This repository is dedicated to tracking issues that enable collaborative efforts to improve the **[Zulip](https://github.com/zulip)** project, getting it production ready for deployment within [OS2](https://www.os2.eu/), ready to serve danish authorities 🇩🇰.
710

8-
If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages.
911

10-
More specifically, the created site:
12+
### ❔ Why Samtale?
13+
- **Contextual and Topic-Driven Conversations**: Participate in [efficient communication, without interuption.](https://zulip.com/why-zulip/)
14+
- **100% [Open Source](https://opensource.com/resources/what-open-source)**: Committed to transparency and community involvement.
15+
- **Hosted in the [OS2 sandbox](https://github.com/OS2sandbox)**: Bringing together ideas, developers and user - working together to mature the project.
16+
- **Built on upstream project [Zulip](https://github.com/zulip)**: Leveraging a robust and proven foundation for messaging.
17+
- **Focused on a holistic delivery**: os2samtale is a wrapper around Zulip, with the goal of delivering a production ready, preconfigured version, ready to deliver real-time-chat to danish authorities.
18+
- **Integrates with your existing accounts**: Supports Single-Sign On with most modern IDPs. Development underway for supporting [municipal login](https://github.com/OS2sandbox/sandbox-myndighedsidentitet/tree/main)
1119

12-
- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
13-
- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
20+
### 🚀 Getting Started
1421

15-
Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
22+
1. **Join GitHub**: Ensure you're part of the world's largest development platform. Sign up [here](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github) if you're new.
23+
2. **Contribute**: [Open an issue](https://github.com/OS2sandbox/sandbox-samtale/issues) and look into [Zulip](https://github.com/zulip) and [docker-zulip](https://github.com/zulip/docker-zulip/) for making upstream contributions!
24+
3. **Learn the Ropes**: New to open-source? [Check out this quick video introduction](https://www.youtube.com/watch?v=RGd5cOXpCQw) to get up to speed.
1625

17-
[Browse our documentation][Just the Docs] to learn more about how to use this theme.
26+
### 💡 Share Your Ideas
1827

19-
To get started with creating a site, simply:
28+
Want to help shape the future of collaborative communication?
2029

21-
1. click "[use this template]" to create a GitHub repository
22-
2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
30+
We appreciate new ideas, suggestions, or improvements. Don't hesitate, just [open an issue](https://github.com/OS2sandbox/sandbox-samtale/issues) and let's start the conversation!
2331

24-
If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README.
25-
26-
----
27-
28-
[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
29-
30-
[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
31-
[GitHub Pages]: https://docs.github.com/en/pages
32-
[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
33-
[Jekyll]: https://jekyllrb.com
34-
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
35-
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
32+
---
33+
###### OS2 – Offentligt digitaliseringsfællesskab ✉️ [email protected]

0 commit comments

Comments
 (0)