Skip to content

Commit 4f7f1e0

Browse files
author
Joel W. King
committed
documentation updates
1 parent 33c3b7d commit 4f7f1e0

File tree

4 files changed

+59
-20
lines changed

4 files changed

+59
-20
lines changed

‎.env/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
Sample
1+
README
22
------
33

4-
This is the format of the `.env/debug.env` file specified in the `.vscode/launch.json` debug configuration
4+
This is the format of the `.env/debug.env` file specified in the `.vscode/launch.json` debug configuration:
55

66
```
7-
ACCESS_KEY=AKXXXXXXXC4PLERT
8-
SECRET_KEY="2WOz2345678hnowi0EWSS"
9-
BUCKET= "foobar"
7+
PZ_ACCESS_KEY=AKXXXXXXXC4PLERT
8+
PZ_SECRET_KEY="2WOz2345678hnowi0EWSS"
9+
PZ_BUCKET= "foobar"
1010
```
11+
The file `run.env` is a sample input environment variable file for use when initiating the code with a stand-along container. Use the argument `--env-file .env/run.env` to specify the file.

‎data/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
README
22
------
33

4-
This directory is a placeholder as a location to store or link to your powerpoint presentations.
4+
This directory is a placeholder location to store a copy of to your Powerpoint presentations for upload to the object store.
5+
6+
The file `tags.json` is a sample tag file which can be used for populating the tags associated with all the files uploaded.

‎documentation/NOTES_TIPS.md

Lines changed: 49 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
NOTES_TIPS
22
----------
3-
43
A few things learned along the way.
54

65
Creating an input inventory file
76
--------------------------------
8-
97
In this example, I created a target directory `~/prezo/data` and copied all the files with an extension of `.pptx` to the target directory.
108

119
`scp ./AnsibleFest2018/*.pptx [email protected]:prezo/data/`
@@ -26,31 +24,70 @@ Then save the modified file. You have created an inventory file listing the full
2624

2725
Stupid Windows Tricks
2826
---------------------
27+
How to locate the file path in Windows.
2928

3029
Reference: https://www.pcworld.com/article/251406/windows-tips-copy-a-file-path-show-or-hide-extensions.html
3130

32-
Open Windows Explorer and find the photo (or document) in question.
33-
Hold down the Shift key, then right-click the photo.
34-
In the context menu that appears, find and click Copy as path. This copies the file location to the clipboard.
35-
(FYI, if you don’t hold down Shift when you right-click, the Copy as path option won’t appear.)
36-
Press Ctrl-V to paste the text in a file.
31+
* Open Windows Explorer and find the photo (or document) in question.
32+
* Hold down the Shift key, then right-click the photo.
33+
* In the context menu that appears, find and click Copy as path. This copies the file location to the clipboard. (FYI, if you don’t hold down Shift when you right-click, the Copy as path option won’t appear.)
34+
* Press Ctrl-V to paste the text in a file.
3735

3836
Mounting USB on VirtualBox
3937
--------------------------
38+
Mounting USB to Linux via VirtualBox to access files from the virtual machine.
39+
40+
Attach the USB drive to your system. Wait for the Operating System to recognize the removable media.
4041

41-
Mounting USB to Linux via VirtualBox to backup files - Create a device filter under USB in Virtual Box Manager
42+
Use the VirtualBox Manager, Select USB, then create (add) a device filter, selecting the USB drive shown in the dialog box.
4243

43-
Locate the device:
44+
>Note: you must power off the virtual machine in Virtual Box Manager and power on after the filter has been created for the USB drive to be recognized by the Linux OS.
45+
46+
Locate the device using either of these Linux commands:
4447

4548
`lsblk`
4649
or
50+
4751
`sudo fdisk -l`
4852

49-
look for `/dev/sdb1` - it may take a few minutes.
53+
look for `/dev/sdb1` - it may take a few minutes.
54+
55+
```
56+
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
57+
sda 8:0 0 16G 0 disk
58+
├─sda1 8:1 0 1M 0 part
59+
├─sda2 8:2 0 1G 0 part /boot
60+
└─sda3 8:3 0 15G 0 part
61+
└─ubuntu--vg-ubuntu--lv 253:0 0 15G 0 lvm /
62+
sdb 8:16 1 14.9G 0 disk
63+
└─sdb1 8:17 1 14.9G 0 part
64+
sr0 11:0 1 1024M 0 rom
65+
```
66+
Create a mount point and mount the media:
5067

5168
```bash
5269
sudo mkdir /media/usb
5370
sudo mount /dev/sdb1 /media/usb
71+
```
72+
73+
After mounting, the mount point is shown:
74+
75+
```
76+
administrator@flint:~$ lsblk
77+
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
78+
sda 8:0 0 16G 0 disk
79+
├─sda1 8:1 0 1M 0 part
80+
├─sda2 8:2 0 1G 0 part /boot
81+
└─sda3 8:3 0 15G 0 part
82+
└─ubuntu--vg-ubuntu--lv 253:0 0 15G 0 lvm /
83+
sdb 8:16 1 14.9G 0 disk
84+
└─sdb1 8:17 1 14.9G 0 part /media/usb
85+
sr0 11:0 1 1024M 0 rom
86+
```
87+
88+
You can unmount the device using the command:
89+
90+
```bash
5491
sudo umount /dev/sdb1
5592
```
5693

@@ -61,20 +98,19 @@ refer to: https://csurfer.github.io/rake-nltk/_build/html/index.html
6198

6299
Converting to US-ASCII
63100
----------------------
101+
Metadata characters must be US-ASCII. There are also limits on the size of the metadata in the HTTP header.
64102

65-
The metadata characters should be US-ASCII. There are also limites on the size of the metadata in the HTTP header.
66103
https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingMetadata.html#object-metadata
67104

68105
https://stackoverflow.com/questions/20078816/replace-non-ascii-characters-with-a-single-space
69106

70107
S3Error
71108
-------
72-
73109
This error:
74110

75111
```minio.error.S3Error: S3 operation failed; code: SignatureDoesNotMatch, message: The request signature we calculated does not match the signature you provided. Check your key and signing method.```
76112

77-
may be the result of non-supported data types in the meta data. For example, lists with a length of > 1.
113+
is the result of non-supported data types in the meta data. For example, lists with a length of > 1.
78114

79115
Author
80116
------

‎requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ rake-nltk
55
python-pptx
66
minio
77
fuzzywuzzy
8-
python-Levenshtein # Optional, a preformance enhancement
8+
python-Levenshtein # Optional, a performance enhancement used by rake-nltk
99
#
1010
# Linting and debugging
1111
#

0 commit comments

Comments
 (0)