Skip to content

Commit fb5aa73

Browse files
authored
Merge branch 'master' into docsearch-earch
2 parents 769e9ff + 7d7bc25 commit fb5aa73

File tree

47 files changed

+324
-95
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+324
-95
lines changed

.devcontainer/devcontainer.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
},
1313
"vscode": {
1414
"extensions": [
15-
"bierner.markdown-mermaid",
1615
"davidanson.vscode-markdownlint",
1716
"ms-python.python"
1817
]

.github/workflows/cleanup_acceptance.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
jobs:
88
cleanup:
99
runs-on: ubuntu-latest
10-
container: quay.io/hypernode/deploy:4-php8.3-node20
10+
container: quay.io/hypernode/deploy:latest-php8.3-node20
1111
environment: acceptance
1212
steps:
1313
- uses: actions/checkout@v2

.github/workflows/deploy.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ env:
1212
jobs:
1313
build:
1414
runs-on: ubuntu-latest
15-
container: quay.io/hypernode/deploy:4-php8.3-node20
15+
container: quay.io/hypernode/deploy:latest-php8.3-node20
1616
steps:
1717
- uses: actions/checkout@v3
1818
with:
@@ -47,7 +47,7 @@ jobs:
4747
name: acceptance
4848
url: ${{ steps.get_brancher_hostname.outputs.BRANCHER_URL }}
4949
if: github.ref != 'refs/heads/master'
50-
container: quay.io/hypernode/deploy:4-php8.3-node20
50+
container: quay.io/hypernode/deploy:latest-php8.3-node20
5151
steps:
5252
- uses: actions/checkout@v3
5353
with:
@@ -102,7 +102,7 @@ jobs:
102102
name: production
103103
url: https://docs.hypernode.io
104104
if: github.ref == 'refs/heads/master'
105-
container: quay.io/hypernode/deploy:4-php8.3-node20
105+
container: quay.io/hypernode/deploy:latest-php8.3-node20
106106
steps:
107107
- uses: actions/checkout@v3
108108
- name: download build artifact

.github/workflows/lint.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Run linting and suggest changes
2+
3+
on:
4+
pull_request:
5+
6+
permissions:
7+
contents: read
8+
pull-requests: write
9+
10+
jobs:
11+
test:
12+
runs-on: ubuntu-latest
13+
strategy:
14+
matrix:
15+
python-version: ['3.10']
16+
17+
steps:
18+
- uses: actions/checkout@v3
19+
- uses: actions/setup-python@v4
20+
with:
21+
python-version: ${{ matrix.python-version }}
22+
- name: Install dependencies
23+
run: |
24+
pip install -r requirements/base.txt
25+
- name: Check markdown format
26+
run: mdformat docs/
27+
- uses: parkerbxyz/suggest-changes@v1
28+
with:
29+
event: 'REQUEST_CHANGES'

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
## Generating new docs
44

5-
``` bash
5+
```bash
66
DOC_URL=https://support.hypernode.com/en/ecommerce/magento-1/how-to-enable-mysql-query-logging-for-magento-1-x
77
bin/download_doc --output-dir=docs/ecommerce-applications $DOC_URL
88
```
99

1010
## Setting up the project
1111

12-
``` bash
12+
```bash
1313
mkvirtualenv hypernode-docs-next
1414
echo "export PYTHONPATH=$(pwd)" >> $VIRTUAL_ENV/bin/postactivate
1515
workon hypernode-docs-next
@@ -19,33 +19,38 @@ pre-commit install
1919

2020
## Building the docs
2121

22-
``` bash
22+
```bash
2323
bin/build_docs
2424
```
2525

2626
## Serving the docs
2727

28-
``` bash
28+
```bash
2929
bin/serve_docs
3030
```
31+
3132
## Setup Frontend step by step
33+
3234
```
3335
clone the repository
3436
pip install -r requirements/development.txt
3537
bin/build_docs
3638
bin/serve_docs
3739
```
40+
3841
in another terminal run
39-
``` bin/watch ```
42+
`bin/watch`
4043

4144
open localhost and now you can make changes in style and refresh the page without rebuilding
4245

4346
when you're working on scss to compile it automatically run
47+
4448
```
4549
npx sass --watch docs/_static/scss:docs/_static/css
4650
```
4751

4852
or as a production build:
53+
4954
```
5055
npx sass --style compressed --no-source-map docs/_static/scss:docs/_static/css
5156
```
@@ -57,6 +62,7 @@ Deploys automatically after merging branchers to master.
5762
### Deploy with Hypernode Deploy
5863

5964
To deploy to a local Hypernode Docker environment:
65+
6066
```
6167
$ docker pull docker.hypernode.com/byteinternet/hypernode-buster-docker:latest
6268
$ docker run docker.hypernode.com/byteinternet/hypernode-buster-docker:latest
@@ -66,6 +72,7 @@ $ # Note the IP address, it should be 172.17.0.2 (otherwise refer to deploy.php)
6672
Next make sure your `~/.ssh/yourdeploykey` equivalent can log in to the Docker host (172.17.0.2) as the app user. You can add it to the `/data/web/.ssh/authorized_keys` file on in the instance manually.
6773

6874
Then deploy to your local Hypernode Docker:
75+
6976
```
7077
docker run --rm -it --env SSH_PRIVATE_KEY="$(cat ~/.ssh/yourdeploykey | base64)" -v ${PWD}:/build quay.io/hypernode/deploy:latest hypernode-deploy build -vvv # First build the artifact
7178
docker run --rm -it --env SSH_PRIVATE_KEY="$(cat ~/.ssh/yourdeploykey | base64)" -v ${PWD}:/build quay.io/hypernode/deploy:latest hypernode-deploy deploy docker -vvv # Then perform the deploy
@@ -74,6 +81,7 @@ docker run --rm -it --env SSH_PRIVATE_KEY="$(cat ~/.ssh/yourdeploykey | base64)"
7481
## Building the manpage deb
7582

7683
The docs are also packaged as a debian package named `hndocsnext` so that on a Hypernode you can run `man hypernode` (or `hypernode-manual`) and page through a `manpage` version of the Hypernode docs. To build that debian package on a Debian machine you can run these commands:
84+
7785
```
7886
# First create the cow environment
7987
export ARCH=amd64
@@ -91,16 +99,19 @@ gbp buildpackage --git-pbuilder --git-dist=$DIST --git-arch=$ARCH --git-ignore-b
9199
```
92100

93101
Then after building the Deb you could install it with dpkg. For example:
102+
94103
```
95104
dpkg -i ../hndocsnext_20230121.173551_all.deb
96105
```
97106

98107
And test it out with:
108+
99109
```
100110
man hypernode
101111
```
102112

103113
To inspect the contents of the deb archive you can run:
114+
104115
```
105116
# dpkg -L hndocsnext
106117
/.

docs/_templates/layout.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -282,13 +282,13 @@ <h4>Need support?</h4>
282282
<div class="aside-tile__container aside-tile__feedback">
283283
<div class="aside-tile__content">
284284
<img src="https://static.hypernode.com/img/icons-multi-color/chat-bot.svg">
285-
<h4>Join our<br>Feedback Group</h4>
285+
<h4>Join our<br>Beta Test Group</h4>
286286
<ul class="aside-tile__feedback-list">
287287
<li><i class="fa fa-check-circle"></i>Experience new features first</li>
288-
<li><i class="fa fa-check-circle"></i>Get a gift after each session</li>
288+
<li><i class="fa fa-check-circle"></i>Get swag & giveaways</li>
289289
<li><i class="fa fa-check-circle"></i>Join product decision making</li>
290290
</ul>
291-
<p><a class="ahref-orange" href="https://forms.gle/ocQjMzhghMkUzkB19" target="_blank">read more</a></p>
291+
<p><a class="ahref-orange" href="https://www.hypernode.com/en/join-feedback-group/" target="_blank">Read more</a></p>
292292
</div>
293293
</div>
294294
</aside>

docs/about-hypernode/billing/how-to-choose-and-order-a-hypernode-plan.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ DigitalOcean and Amazon both have data centers all over the world.
6868

6969
You can order a Hypernode plan via our [order page](https://www.hypernode.com/magento-cloud-hosting/#plans). The Control Panel is our default panel, which means all new Hypernode plans and trials will be booted in the Control Panel.
7070

71-
**Please note:** if you are a Service Panel user (i.e. you use the Dutch panel), please order your new plans directly via [this page in the Service Panel](https://service.byte.nl/planinfo/order-selection/). This is to prevent plans from being booted in the wrong system.
72-
7371
## Tips For Ordering a Hypernode
7472

7573
- Choose a logical name. IE: If your site is example.com, order example.hypernode.com

docs/about-hypernode/security-policies/security-hall-of-fame.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ We would like to thank the following individuals and/or organizations, who have
2929
| [Pethuraj M](https://www.pethuraj.com/) | 1 July 2020 | Reported a flaw in our password reset flow |
3030
| [Miguel Santareno](https://www.linkedin.com/in/miguelsantareno/) | 14 May 2020 | Reported information leakage from marketing sites. |
3131
| [Gaurav Kumar](https://www.facebook.com/drago4344) and [Shivam Dattana](https://www.facebook.com/profile.php?id=100010397858328) / [Team Bugmania](https://www.openbugbounty.org/researchers/bugmania/) | 28 September 2019 | Reported a Cross site scripting (XSS) on magereport.com. |
32-
| [Mike de Landgraaf](https://www.linkedin.com/in/mdelandgraaf/) / [MDL Online](https://mdlonline.com/) | 21 March 2019 | Reported a misconfiguration that allowed user impersonation on Hypernode hosted webshops. |
32+
| [Mike de Landgraaf](https://www.linkedin.com/in/mdelandgraaf/) / MDL Online | 21 March 2019 | Reported a misconfiguration that allowed user impersonation on Hypernode hosted webshops. |
3333
| [Maksym Bendeberia](https://www.linkedin.com/in/jogspokoen/) / [WebSafety Ninja](https://websafety.ninja/) | 12 March 2019 | Reported information leakage from an internal deployment server. |
3434
| [Jan Piet van Dijk](https://www.linkedin.com/in/janpietvandijk/) / [Interwijs B.V.](https://www.interwijs.nl/) | 28 August 2018 | Reported a privilege escalation on Hypernode, leading to a local root exploit. |
3535
| [Wijnand Wieskamp](https://www.linkedin.com/in/wijnand-wieskamp-8a784313/) / [Crystalsoft B.V.](https://www.crystalsoft.nl/) | 1 June 2018 | Reported a misconfiguration that allowed a Hypernode’s preconfigured security settings to be bypassed. |

docs/about-hypernode/support/how-to-handle-os-and-room-change-upgrade.md

100755100644
File mode changed.

docs/best-practices/database/how-to-run-rabbitmq-on-hypernode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ To configure RabbitMQ in Magento 2, you can run the following command:
8585

8686
```bash
8787
bin/magento setup:config:set \
88-
--amqp-host="rabbitmqmaster" \
88+
--amqp-host="rabbitmq" \
8989
--amqp-port="5672" \
9090
--amqp-user="guest" \
9191
--amqp-password="guest" \

0 commit comments

Comments
 (0)