Made documentation ready for production
This commit is contained in:
19
docs/Dockerfile
Normal file
19
docs/Dockerfile
Normal file
@@ -0,0 +1,19 @@
|
||||
FROM jetbrains/writerside-builder:243.22562 AS build
|
||||
|
||||
ARG INSTANCE=Writerside/hopframe
|
||||
|
||||
RUN mkdir /opt/sources
|
||||
|
||||
WORKDIR /opt/sources
|
||||
|
||||
ADD Writerside ./Writerside
|
||||
|
||||
RUN export DISPLAY=:99 && Xvfb :99 & /opt/builder/bin/idea.sh helpbuilderinspect --source-dir /opt/sources --product $INSTANCE --runner other --output-dir /opt/wrs-output/
|
||||
|
||||
WORKDIR /opt/wrs-output
|
||||
|
||||
RUN unzip -O UTF-8 webHelpHOPFRAME2-all.zip -d /opt/wrs-output/unzipped-artifact
|
||||
|
||||
FROM httpd:2.4 AS http-server
|
||||
|
||||
COPY --from=build /opt/wrs-output/unzipped-artifact/ /usr/local/apache2/htdocs/
|
||||
@@ -3,8 +3,8 @@
|
||||
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
||||
|
||||
<variables></variables>
|
||||
<build-profile instance="hopframe">
|
||||
<sitemap priority="0.35" change-frequency="monthly"/>
|
||||
<variables>
|
||||
<noindex-content>false</noindex-content>
|
||||
</variables>
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
|
||||
<instance-profile id="hopframe"
|
||||
name="HopFrame"
|
||||
start-page="starter.md">
|
||||
start-page="Overview.md">
|
||||
|
||||
<toc-element topic="starter.md"/>
|
||||
<toc-element topic="Overview.md"/>
|
||||
<toc-element topic="Installation.md"/>
|
||||
<toc-element topic="Authentication.md"/>
|
||||
<toc-element toc-title="Core Module">
|
||||
|
||||
@@ -6,40 +6,4 @@
|
||||
<accepts>page.html</accepts>
|
||||
</rule>
|
||||
-->
|
||||
<rule id="50095ff3">
|
||||
<description>Created after removal of "SelectEntityEvent" from HopFrame</description>
|
||||
<accepts>SelectEntityEvent.html</accepts>
|
||||
</rule>
|
||||
<rule id="7d9a1af8">
|
||||
<description>Created after removal of "UpdateEntityEvent" from HopFrame</description>
|
||||
<accepts>UpdateEntityEvent.html</accepts>
|
||||
</rule>
|
||||
<rule id="701228d0">
|
||||
<description>Created after removal of "CreateEntityEvent" from HopFrame</description>
|
||||
<accepts>CreateEntityEvent.html</accepts>
|
||||
</rule>
|
||||
<rule id="4b4c2b45">
|
||||
<description>Created after removal of "DeleteEntityEvent" from HopFrame</description>
|
||||
<accepts>DeleteEntityEvent.html</accepts>
|
||||
</rule>
|
||||
<rule id="39604ad3">
|
||||
<description>Created after removal of "TableInitializedEvent" from HopFrame</description>
|
||||
<accepts>TableInitializedEvent.html</accepts>
|
||||
</rule>
|
||||
<rule id="2d6b7079">
|
||||
<description>Created after removal of "PageChangeEvent" from HopFrame</description>
|
||||
<accepts>PageChangeEvent.html</accepts>
|
||||
</rule>
|
||||
<rule id="6933278d">
|
||||
<description>Created after removal of "ReloadEvent" from HopFrame</description>
|
||||
<accepts>ReloadEvent.html</accepts>
|
||||
</rule>
|
||||
<rule id="2043e755">
|
||||
<description>Created after removal of "SearchEvent" from HopFrame</description>
|
||||
<accepts>SearchEvent.html</accepts>
|
||||
</rule>
|
||||
<rule id="2dee3925">
|
||||
<description>Created after removal of "ValidationEvent" from HopFrame</description>
|
||||
<accepts>ValidationEvent.html</accepts>
|
||||
</rule>
|
||||
</rules>
|
||||
@@ -1,3 +0,0 @@
|
||||
# CreateEntityEvent
|
||||
|
||||
Start typing here...
|
||||
@@ -1,3 +0,0 @@
|
||||
# DeleteEntityEvent
|
||||
|
||||
Start typing here...
|
||||
@@ -14,7 +14,7 @@ public abstract class HopFrameEventArgs {
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
**Properties:**
|
||||
|
||||
- **Sender**: The sender of the event.
|
||||
- **Type:** `TSender`
|
||||
@@ -23,7 +23,7 @@ public abstract class HopFrameEventArgs {
|
||||
- **Table**: The table configuration related to the event.
|
||||
- **Type:** `TableConfig`
|
||||
|
||||
### Methods
|
||||
**Methods:**
|
||||
|
||||
- **SetCancelled**
|
||||
- **Parameters:**
|
||||
@@ -40,7 +40,7 @@ public sealed class DeleteEntryEvent : HopFrameEventArgs {
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
**Properties:**
|
||||
|
||||
- **Entity**: The entity being deleted.
|
||||
- **Type:** `object`
|
||||
@@ -65,7 +65,7 @@ public sealed class UpdateEntryEvent : HopFrameEventArgs {
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
**Properties:**
|
||||
|
||||
- **Entity**: The entity being updated.
|
||||
- **Type:** `object`
|
||||
@@ -81,7 +81,7 @@ public sealed class SelectEntryEvent : HopFrameEventArgs {
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
**Properties:**
|
||||
|
||||
- **Entity**: The entity being selected.
|
||||
- **Type:** `object`
|
||||
@@ -100,7 +100,7 @@ public sealed class PageChangeEvent : HopFrameEventArgs {
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
**Properties:**
|
||||
|
||||
- **CurrentPage**: The current page number.
|
||||
- **Type:** `int`
|
||||
@@ -132,7 +132,7 @@ public sealed class SearchEvent : HopFrameEventArgs {
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
**Properties:**
|
||||
|
||||
- **SearchTerm**: The search term used.
|
||||
- **Type:** `string`
|
||||
@@ -143,7 +143,7 @@ public sealed class SearchEvent : HopFrameEventArgs {
|
||||
- **TotalPages**: The total number of pages of search results.
|
||||
- **Type:** `int`
|
||||
|
||||
### Methods
|
||||
**Methods:**
|
||||
|
||||
- **SetSearchResult**
|
||||
- **Parameters:**
|
||||
@@ -172,14 +172,14 @@ public class TableInitializedEvent : HopFrameEventArgs {
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
**Properties:**
|
||||
|
||||
- **PluginButtons**: The list of plugin buttons for the table.
|
||||
- **Type:** `List<PluginButton>`
|
||||
- **DefaultButtons**: The default button toggles for the table.
|
||||
- **Type:** `DefaultButtonToggles`
|
||||
|
||||
### Methods
|
||||
**Methods:**
|
||||
|
||||
- **AddPageButton**
|
||||
- **Parameters:**
|
||||
@@ -206,7 +206,7 @@ public sealed class ValidationEvent : HopFrameEventArgs {
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
**Properties:**
|
||||
|
||||
- **Errors**: The list of validation errors.
|
||||
- **Type:** `IList<string>`
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
# PageChangeEvent
|
||||
|
||||
Start typing here...
|
||||
@@ -1,3 +0,0 @@
|
||||
# ReloadEvent
|
||||
|
||||
Start typing here...
|
||||
@@ -1,3 +0,0 @@
|
||||
# SearchEvent
|
||||
|
||||
Start typing here...
|
||||
@@ -1,3 +0,0 @@
|
||||
# SelectEntityEvent
|
||||
|
||||
Start typing here...
|
||||
@@ -1,3 +0,0 @@
|
||||
# TableInitializedEvent
|
||||
|
||||
Start typing here...
|
||||
@@ -1,3 +0,0 @@
|
||||
# UpdateEntityEvent
|
||||
|
||||
Start typing here...
|
||||
@@ -1,3 +0,0 @@
|
||||
# ValidationEvent
|
||||
|
||||
Start typing here...
|
||||
@@ -7,5 +7,5 @@
|
||||
<images dir="images" web-path="images"/>
|
||||
<categories src="c.list"/>
|
||||
<vars src="v.list"/>
|
||||
<instance src="hopframe.tree" version="3.2.0"/>
|
||||
<instance src="hopframe.tree"/>
|
||||
</ihp>
|
||||
Reference in New Issue
Block a user