From 0c9621922ee6525f2ad6fd31df39f1c558868f9f Mon Sep 17 00:00:00 2001
From: Rob Herley <robherley@github.com>
Date: Wed, 6 Dec 2023 04:22:18 +0000
Subject: [PATCH] add faq, update releases

---
 packages/artifact/README.md    |  7 +++++++
 packages/artifact/RELEASES.md  |  5 +++++
 packages/artifact/docs/docs.md |  1 -
 packages/artifact/docs/faq.md  | 35 ++++++++++++++++++++++++++++++++++
 4 files changed, 47 insertions(+), 1 deletion(-)
 delete mode 100644 packages/artifact/docs/docs.md
 create mode 100644 packages/artifact/docs/faq.md

diff --git a/packages/artifact/README.md b/packages/artifact/README.md
index 580c4ae8..70752289 100644
--- a/packages/artifact/README.md
+++ b/packages/artifact/README.md
@@ -14,6 +14,7 @@ This is the core library that powers the [`@actions/upload-artifact`](https://gi
     - [Upload and Download](#upload-and-download)
     - [Downloading from other workflow runs or repos](#downloading-from-other-workflow-runs-or-repos)
     - [Speeding up large uploads](#speeding-up-large-uploads)
+  - [Additional Resources](#additional-resources)
 
 ## v2 - What's New
 
@@ -136,3 +137,9 @@ await artifact.uploadArtifact('my-massive-artifact', ['big_file.bin'], {
   compressionLevel: 0
 })
 ```
+
+## Additional Resources
+
+- [Releases](./RELEASES.md)
+- [Contribution Guide](./CONTRIBUTIONS.md)
+- [Frequently Asked Questions](./docs/faq.md)
diff --git a/packages/artifact/RELEASES.md b/packages/artifact/RELEASES.md
index 580d840b..53a8dda5 100644
--- a/packages/artifact/RELEASES.md
+++ b/packages/artifact/RELEASES.md
@@ -94,3 +94,8 @@
 ### 1.1.1
 
 - Fixed a bug in Node16 where if an HTTP download finished too quickly (<1ms, e.g. when it's mocked) we attempt to delete a temp file that has not been created yet [#1278](https://github.com/actions/toolkit/pull/1278/commits/b9de68a590daf37c6747e38d3cb4f1dd2cfb791c)
+
+### 2.0.0
+
+Major release. Supports new Artifact backend for improved speed, reliability and behavior.
+Numerous API changes, some breaking.
diff --git a/packages/artifact/docs/docs.md b/packages/artifact/docs/docs.md
deleted file mode 100644
index e0fa3110..00000000
--- a/packages/artifact/docs/docs.md
+++ /dev/null
@@ -1 +0,0 @@
-Docs will be added here once development of version `2.0.0` has finished
\ No newline at end of file
diff --git a/packages/artifact/docs/faq.md b/packages/artifact/docs/faq.md
new file mode 100644
index 00000000..8700787f
--- /dev/null
+++ b/packages/artifact/docs/faq.md
@@ -0,0 +1,35 @@
+# Frequently Asked Questions
+
+- [Frequently Asked Questions](#frequently-asked-questions)
+  - [Supported Characters](#supported-characters)
+  - [Compression? ZIP? How is my artifact stored?](#compression-zip-how-is-my-artifact-stored)
+
+## Supported Characters
+
+When uploading an artifact, the inputted `name` parameter along with the files specified in `files` cannot contain any of the following characters. They will be rejected by the server if attempted to be sent over and the upload will fail. These characters are not allowed due to limitations and restrictions with certain file systems such as NTFS. To maintain platform-agnostic behavior, all characters that are not supported by an individual filesystem/platform will not be supported on all filesystems/platforms.
+
+- "
+- :
+- <
+- \>
+- |
+- \*
+- ?
+
+In addition to the aforementioned characters, the inputted `name` also cannot include the following
+- \
+- /
+
+## Compression? ZIP? How is my artifact stored?
+
+When creating an Artifact, the files are dynamically compressed and streamed into a ZIP archive. Since they are stored in a ZIP, they can be compressed by Zlib in varying levels.
+
+The value can range from 0 to 9:
+
+- 0: No compression
+- 1: Best speed
+- 6: Default compression (same as GNU Gzip)
+- 9: Best compression
+
+Higher levels will result in better compression, but will take longer to complete.
+For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.