You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-12Lines changed: 3 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,11 +82,7 @@ Over time, we should track which items are useful and which don't get any traffi
82
82
## Installation and setup
83
83
84
84
1. Use Git to clone this repository.
85
-
2. If you work at Apify and can install packages prefixed with `@apify-packages`, you can skip this step.
86
-
Otherwise go to GitHub and navigate to [Settings / Personal access tokens / Tokens (classic)](https://github.com/settings/tokens).
87
-
Despite the UI suggesting you should use the new fine-grained tokens, generate a **classic token** with scopes **repo** and **write:packages**.
88
-
Keep the token somewhere safe.
89
-
Then run the following command and use your GitHub username together with the token as credentials:
85
+
2. If you work at Apify and can install packages prefixed with `@apify-packages`, you can skip this step. Otherwise go to GitHub and navigate to [Settings / Personal access tokens / Tokens (classic)](https://github.com/settings/tokens). Despite the UI suggesting you should use the new fine-grained tokens, generate a **classic token** with scopes **repo** and **write:packages**. Keep the token somewhere safe. Then run the following command and use your GitHub username together with the token as credentials:
@@ -96,18 +92,13 @@ Over time, we should track which items are useful and which don't get any traffi
96
92
3. Run `npm install`.
97
93
4. Run `npm start`. The website should open at <http://localhost:3000>.
98
94
99
-
This is sufficient to work on the main content, i.e. the Academy and Platform docs.
100
-
If you want to also work on the other parts of the docs, you may want to first join them all together using Nginx.
95
+
This is sufficient to work on the main content, i.e. the Academy and Platform docs. If you want to also work on the other parts of the docs, you may want to first join them all together using Nginx.
101
96
102
97
### Join all the docs repos together using Nginx
103
98
104
99
By default, the parts of the docs sourced from other repositories will give you 404s. If you need to locally run the project with all the other repositories included, clone them all and setup an Nginx server according to the steps below.
105
100
106
-
For the setup to work, use `npm start:dev` instead of `npm start` when starting `apify-docs`.
107
-
This causes all links in the top navigation and the footer to be absolute.
108
-
They will now use `docs.apify.loc` as a host.
109
-
Clone all the remaining docs repositories, and start their Docusaurus instances.
110
-
To run Docusaurus on a specific port, use `npm start -- --port XXXX`.
101
+
For the setup to work, use `npm start:dev` instead of `npm start` when starting `apify-docs`. This causes all links in the top navigation and the footer to be absolute. They will now use `docs.apify.loc` as a host. Clone all the remaining docs repositories, and start their Docusaurus instances. To run Docusaurus on a specific port, use `npm start -- --port XXXX`.
0 commit comments