Create README.md for documentation

Author: sofia-tekdatum

documents/README.md

@@ -0,0 +1,20 @@
+# PME Extensions - Document Index
+
+This folder contains the PME Extension Project's deliverable documents as PDFs. We also provide links to the original Google Document.
+
+| Document Title | GitHub Link (PDF) | Google Doc (Original) | Category | Notes |
+| :--- | :--- | :--- | :--- | :--- |
+| PME Extensions Project Overview | [View](./documents/PME%20Extensions%20Project%20Overview.pdf) | [Link](https://docs.google.com/document/d/148HU3jJcgkhmKSH7dkRPQ4Y-QQyEpsnbjJG5CJ6nb74/edit?tab=t.0#heading=h.tagk2kxp3sfy) | Product | Brief summary of project goals. |
+| Proposal to Apache Arrow | [View](./documents/Proposal%20to%20Apache%20Arrow%20to%20Extend%20PME.pdf) | [Link](https://docs.google.com/document/d/1yj7RB51egSyA_IE_AuKzENB6AC-LL3yitpgeT0tnjNc/edit?tab=t.0#heading=h.9pn98amwfcdh) | Design | This document serves as the full project description and design that should be presented to the Arrow community for review. |
+| API for External Encryption Service | [View](./documents/API%20for%20an%20External%20Encryption%20Service.pdf) | [Link](https://docs.google.com/document/d/1wTXtqb5U57R-2b8MkE9WI-uhrHRIm19Kr_4hJe1DcRQ/edit?tab=t.0#heading=h.rowf4zsfj9vr) | Design | Description of the DBPA RESTful API. |
+| Measuring Cost of Per-value Encryption | [View](./documents/Measuring%20the%20Cost%20of%20Per-value%20Encryption%20with%20DBPA.pdf) | [Link](https://docs.google.com/document/d/1ZnWSIch8GKIbMCZaIMn4MIXkzBMmdaWTB17NXsOjeiA/edit?tab=t.0#heading=h.xopwoubageoo) | Testing | Description of the setup for the tests used to measure the performance and cost of running the PME extension project. |
+| Before Launching to Production | [View](./documents/Before%20Launching%20to%20Production.pdf) | [Link](https://docs.google.com/document/d/1N5XqPY03-AfyZyTp9hqd525ZYvilcXbboVSXiclX-A4/edit?tab=t.0#heading=h.xf9qf8ac93u4) | Deployment | Checklist for the Protegrity team of things that must be done before launching PME to production. |
+| Protegrity Arrow Code Map | [View](./documents/Protegrity%20Arrow%20Code%20Map.pdf) | [Link](https://docs.google.com/document/d/1AGugwbS0d8NYIU4fFcWmGbtetyE2MksPnYuSkYNg7iY/edit?tab=t.0#heading=h.7v583e3j445c) | Dev Guide | Code locations and summary of the changes, for use when merging with future stable versions of Arrow. |
+| External Encryptor + DLL Interfaces | [View](./documents/External%20Encryptor%20+%20DLL%20Interfaces%20and%20Contracts.pdf) | [Link](https://docs.google.com/document/d/1nPwhpR4bTIRNHRbjePjuNTmbu5H5IeZhT7miImjaJ2o/edit?tab=t.0#heading=h.mfkazk6zt07j) | Design | Outline interfaces and contracts for using external encryptors and decryptors with PME in Arrow. |
+| PME External Config & Properties | [View](./documents/PME%20External%20Config%20and%20Properties%20Discussion.pdf) | [Link](https://docs.google.com/document/d/1Tjb45rQ2x9FydFmFIRo-U6PNJnEQ5_CfdCC4EU8M6D0/edit?tab=t.0#heading=h.2eoatj99v0gp) | Design | Design considerations used when creating the external versions of the EncryptionConfig, DecryptionConfig, FileEncryptionProperties, and FileDecryptionProperties. |
+| Overcoming Arrow CiphertextLength | [View](./documents/Overcoming%20Arrow's%20need%20for%20CiphertextLength.pdf) | [Link](https://docs.google.com/document/d/1e5VwLyWmjuqPR6wi6UJm0JhLdU7VSn920HjaR_8af1s/edit?tab=t.0#heading=h.pwd3zpq2h302) | Design | Options evaluated for dealing with Arrow’s use of ciphertext length before performing encryption and decryption. |
+| PME Extension Testing Plan | [View](./documents/PME%20Extension%20Testing%20Plan.pdf) | [Link](https://docs.google.com/document/d/1bPI_jB7aDiveNy61iKB5HRP17r1w-yfzfpXqKiY_XG4/edit?tab=t.0#heading=h.7s8ojrm0w4th) | Testing | Description of the testing plan implemented for the PME extension project. |
+| Developing Arrow + DBPS | [View](./documents/Developing%20Arrow%20+%20DBPS.pdf) | [Link](https://docs.google.com/document/d/1O8-NyKFN7XlyURTNe-iHX_pBhRNIjN7Q6fKGBg1lOQ8/edit?tab=t.0#heading=h.p3uaka5dksed) | Dev Guide | Instructions for compiling, running, developing, and testing the PME extension project. |
+| Tech Debt + Gotchas | [View](./documents/Tech%20Debt%20+%20Gotchas.pdf) | [Link](https://docs.google.com/document/d/1XYNLJXmbvWvqIW_7Zzb6XPbj52X4_Pd-_HzRioC53WM/edit?tab=t.0#heading=h.6dkr8l8h2uej) | Dev Guide | Outline remaining tech debt, potential issues, and future work for the PME extension project. |
+| Distributing DBPS Shared Libraries | [View](./documents/Distributing%20DBPS%20Shared%20Libraries.pdf) | [Link](https://docs.google.com/document/d/1__LbR6i4yWi3O49vyPzDD6gEFfTwiIMOUcBAHWDpRUI/edit?tab=t.0#heading=h.44mscutrtael) | Design | Options evaluated and pros/cons for distributing shared libraries. |
+| [v0] PME Language Bindings Support | [View](./documents/[v0]%20PME%20support%20across%20various%20language%20bindings.pdf) | [Link](https://docs.google.com/document/d/1yLWVlQ_9bCggh3V6rejLhmRMdR3onu-3CamEt2kcP_g/edit?tab=t.0#heading=h.pdh914p6kttv) | Design | Summary of PME support and implementation details in other languages. |