Skip to content

Run configs #1236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 4, 2025
Merged

Run configs #1236

merged 6 commits into from
Jun 4, 2025

Conversation

AndreiKingsley
Copy link
Collaborator

Add run configurations for local Writerside deployment (build and serve locally).
Requires python3 and unzip to be available in your environment.

@@ -0,0 +1,17 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="Run Docs Webiste Locally" type="ShConfigurationType">
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo in Website

@@ -0,0 +1,17 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="Run Docs Webiste Locally" type="ShConfigurationType">
<option name="SCRIPT_TEXT" value="unzip -o webHelpD2-all.zip -d webHelpD2-all &amp;&amp; cd webHelpD2-all &amp;&amp; python3 -m http.server 8000" />
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also, probably add all created webhelp files to .gitignore to prevent accidental additions

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you put them inside /build?

docs/README.md Outdated

> Requires: `unzip` utility and **Python 3** installed in the environment. May not work properly on Windows.

1. Run the **Build Docs Website** configuration.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you type it with backticks, you get clickable gutter icons ;)
image

Copy link
Collaborator

@Jolanrensen Jolanrensen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

other than that, looks good :)

1. Run the **Build Docs Website** configuration.
2. Run the **Run Docs Website Locally** configuration.
3. Open [http://localhost:8000/home.html](http://localhost:8000/home.html) in your browser.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

step 4: ctrl+c to stop it? otherwise you might run into port-in-use issues

@AndreiKingsley AndreiKingsley merged commit fe0373c into master Jun 4, 2025
2 checks passed
@AndreiKingsley AndreiKingsley deleted the run_configs branch June 4, 2025 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants