Skip to content

Commit f08251e

Browse files
committed
Update documentation
1 parent f1a0e75 commit f08251e

File tree

3 files changed

+21
-9
lines changed

3 files changed

+21
-9
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
## Setup
3939

4040
```shell
41-
pip install --upgrade 'git+https://github.com/crate-workbench/hubspot-tech-writing'
41+
pip install --upgrade hubspot-tech-writing
4242
```
4343

4444
After installation, you can verify if it was successful.
@@ -76,23 +76,30 @@ hstw linkcheck https://github.com/crate-workbench/hubspot-tech-writing/raw/main/
7676

7777
### HubSpot Upload
7878

79-
Uploading to HubSpot is mostly an iterative process, so will likely need to use the
80-
program multiple times. In order ease invocation, we recommend to define an
81-
environment variable for storing your access token.
79+
Uploading to HubSpot is mostly an iterative process, so you will most likely need to use the
80+
program multiple times on the same resource. In order ease invocation, we recommend to define
81+
an environment variable for storing your access token to the HubSpot API.
8282
```shell
8383
export HUBSPOT_ACCESS_TOKEN=pat-na1-e8805e92-b7fd-5c9b-adc8-2299569f56c2
8484
```
8585

86+
Upload HTML file from workstation.
87+
The name of the blog post will be derived from the file name.
8688
```shell
87-
# Upload HTML file from workstation.
88-
# The name of the blog post will be derived from the file name.
8989
hstw upload testdrive.html
9090
```
91+
92+
Upload PNG image from workstation to folder path on hubfs.
9193
```shell
92-
# Upload PNG image from workstation to folder path on hubfs.
9394
hstw upload testdrive.png --folder-path=/foo/bar
9495
```
9596

97+
Convert Markdown to HTML, upload the document under a different name, and also upload all
98+
referenced images.
99+
```shell
100+
hstw upload /path/to/document.md --name=a-different-name --folder-path=/blog/2023/topic
101+
```
102+
96103
For more detailed information about this feature, please refer to the inline help:
97104
```shell
98105
hstw upload --help

docs/backlog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- Use HubSpot title from Markdown
1111
- Remove MyST specialities, e.g. `(full-text)=`
1212
- File bug: Uploading/updating blog post via identifier does not work
13+
- Don't upload files over and over again
1314
- Release 0.1.0
1415

1516
### Documentation
@@ -53,6 +54,10 @@
5354
- https://observablehq.com/@observablehq/introduction-to-ai-assist
5455
- https://observablehq.com/blog/improving-ai-assist
5556

57+
### write freely
58+
- https://writefreely.org/
59+
- https://github.com/writefreely/writefreely
60+
5661

5762
## Done
5863
- Permalinks for headers

hubspot_tech_writing/cli.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,13 +176,13 @@ def linkcheck_cli(source: str):
176176
"--folder-id",
177177
type=str,
178178
required=False,
179-
help="The folder id for storing files. Needed when creating a file item. Alternatively, use folder name.",
179+
help="The folder id for storing files. Alternatively, use folder name.",
180180
)
181181
@click.option(
182182
"--folder-path",
183183
type=str,
184184
required=False,
185-
help="The folder path for storing files. Needed when creating a file item. Alternatively, use folder id.",
185+
help="The folder path for storing files. Alternatively, use folder id.",
186186
)
187187
@access_token_option
188188
def upload_cli(access_token: str, source: str, name: str, content_group_id: str, folder_id: str, folder_path: str):

0 commit comments

Comments
 (0)