Skip to content

Commit

Permalink
Upgraded dependencies, removed support page and added blog page
Browse files Browse the repository at this point in the history
  • Loading branch information
nikola-jokic committed Feb 29, 2024
1 parent 742f60c commit de0962d
Show file tree
Hide file tree
Showing 11 changed files with 1,321 additions and 1,530 deletions.
14 changes: 7 additions & 7 deletions content/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,6 @@ What's included
Build your own stuff on top of BountyHub!
::

::card{icon=heroicons-outline:pencil-alt}
#title
[Support](/support/about)
#description
How to contact support and raise issues or feature requests
::

::card{icon=heroicons-outline:bell}
#title
[Notifications](/notifications/about)
Expand All @@ -70,4 +63,11 @@ What's included
about all changes to your runs
::

::card{icon=heroicons-outline:pencil-alt}
#title
[Blog](/blog/about)
#description
How to contact support and raise issues or feature requests
::

::
17 changes: 17 additions & 0 deletions content/1.workflows/1.syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,23 @@ The script lives only during the step. It will be cleaned up after each step.

To write a script, you can use template evaluation syntax. To read more about that, please visit "Template evaluation" section.

::alert{type="note"}
There may be situations where workflow syntax looks valid, but the server fails to parse it.

For example:
```yaml
- run: sleep $((sleep_time > 0 ? sleep_time : 0)); echo "test"
shell: bash
```

To fix this problem, you can do the following:
```yaml
- run: |
sleep $((sleep_time > 0 ? sleep_time : 0)); echo "test"
shell: bash
```
::

### `scans[].steps[].shell`

Shell specifies the executable that is going to execute the script. The runner uses shell as an argument to the `which` command. If the executable does not exist on the path, the step will fail.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Notifications"
description: "Configuring notifications related to project events"
---

## Notifications
# Notifications

The idea behind notifications is so you can be notified on certain events that may be of interest to you. They may originate from

Expand All @@ -21,15 +21,15 @@ deleted, maybe there is another one and you should start the subdomain discovery

The idea is for you to be busy hunting, and only spend as little time as possible gathering information.

### E-mails
## E-mails

These are e-mail addresses that you can use to be notified on, and can be different from your primary e-mail address. Primary e-mail address is only used for profile related actions, such as password reset etc.

On the other hand, notification e-mails are only used so you can be notified about events. You can duplicate your primary e-mail address.

**You cannot use it to sign in or any other profile related action**.

### Slacks
## Slacks

Slack notifications are based on the BountyHub App. App is installed to your workspace.

Expand Down
File renamed without changes.
14 changes: 0 additions & 14 deletions content/4.support/1.about.md

This file was deleted.

2 changes: 0 additions & 2 deletions content/4.support/_dir.yaml

This file was deleted.

53 changes: 53 additions & 0 deletions content/5.blogs/1.blogs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
title: "Blogs"
---

# Blogs

Blogs are a way to communicate with the community. They are a way to share your knowledge
with the rest of the community, and express your ideas. They are also a way to share your
experiences, and to share your knowledge with the rest of the community.

On the other hand, when hacking, you suddenly remember something that you have read, and
you can't remember where you have read it. You can bookmark blog posts from other users
and refer to them later.

## Writing a blog

To write a blog, you need to have a user account. You can create a user account by
visiting the [sign up](https://bountyhub.org/sign-up) page.

Once you have a user account, in the sidebar, you will see "My Blog" link. Clicking on
that link will take you to the page where you can create a new blog post.

Blog post is created as a draft right away. You can edit it and save progress as you go.
Once you are ready to publish, you can click on the "Save and publish" button.

### Blog post structure

Blog post consists of 4 main parts:

- Title - Title of the blog post
- Description - Short description of the blog post that is visible in the list of blog posts
- Labels - Labels are used to categorize blog posts. You can use labels to categorize your blog posts, and to make it easier for other users to find your blog posts.
- Content - Content of the blog post. You can use markdown to format your blog post.

Blog post is saved as HTML, but it does not allow styling. The reason is to make uniform look and feel of the blog posts.

It is also possible to embed images by uploading them from your computer, or referring to them using a link.

### Labels

Labels are used to categorize blog posts. You can use labels to categorize your blog posts, and to make it easier for other users to find your blog posts. You can use multiple labels for a single blog post. You can also use labels to find blog posts from other users.

Labels are in form of a handle, i.e. alphanumeric characters, and dashes. They are case insensitive.

### Content

Content is written using WYSIWYG editor. The editor used is [TipTap](https://www.tiptap.dev/). It is a rich text editor that allows you to format your text using markdown.

### Images

You can embed images in your blog post. You can upload images from your computer, or you can refer to them using a link. You can also use images from the internet, but make sure that you have the right to use them.

To upload an image, you can drag and drop it to the editor, or you can click on the "Upload image" button.
11 changes: 11 additions & 0 deletions content/5.blogs/2.about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "About page"
---

# About

The intention of this page is for you to write something about you. It does not have to be in form of a CV, but it can be. The intention of this page is to show other users who you are, and what you are interested in.

## Writing about yourself

About page uses the same editor as the blog posts. It contains the same constraints as the blog posts, and it is saved as HTML. It does not allow styling, to make uniform look and feel of the about pages.
2 changes: 2 additions & 0 deletions content/5.blogs/_dir.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
title: 'Blogs'
icon: 'heroicons-outline:pencil-alt'
2 changes: 1 addition & 1 deletion content/999.announcements/1.all.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ title: "All announcements"

## BountyHub is in Alpha

BountyHub is now in alpha version. There are a lot of missing pieces and likely bugs, but hopefully, you will stick with it, and it is going to be awesome! For any feature requests, please submit a support ticket or e-mail me at [nikola.jokic@bountyhub.org](mailto://nikola.jokic@bountyhub.org).
BountyHub is now in alpha version. There are a lot of missing pieces and likely bugs, but hopefully, you will stick with it, and it is going to be awesome! For any feature requests, please submit a support ticket or e-mail me at [nikola.jokic@bountyhub.org](mailto:nikola.jokic@bountyhub.org).

There is also a [weekly call](https://bountyhub.org/bountyhub#meet). Feel free to join!
Loading

0 comments on commit de0962d

Please sign in to comment.