Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion content/docs/tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,32 @@ If you have a tool to add to the list, please let the OSN team know at {{< help-
| **Tool** | **Language** | **Platform** |
|----------|--------------|--------------|
| [Boto3](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) | Python | All |
| [aws.s3](https://cloud.r-project.org/web/packages/aws.s3/index.html) | R | All |
| [aws.s3](https://cloud.r-project.org/web/packages/aws.s3/index.html) | R | All |

## Best Practices

### Naming Conventions

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Mark this clearly as "this don't use these characters and why." I think it may be misinterpreted at a glance.

For broad compatibility with tools, libraries, and filesystems: use lower-case letters, numbers, spaces, hyphens (`-`), underscores (`_`), and periods (`.`) in file and folder names. Avoid unnecessary special characters, names that differ only by capitalization, and leading or trailing spaces or periods. Deviating from this may result in data that is unreadable in certain circumstances.

S3 permits many special characters in object names, but some tools and libraries may interpret them differently. For example, a name containing a plus sign (`+`) may conflict with an otherwise identical name containing a space:

```text
test file.txt
test+file.txt
```

Names that differ only by capitalization may also conflict when used with some tools or filesystems:

```text
test file.txt
Test File.txt
```

Forward slashes (`/`) may be used to separate "folders" or "directories" in a path, such as:

```text
project/data/test file.txt
```

However, a forward slash should not be used within the name of an individual file or directory.