summaryrefslogtreecommitdiffstats
path: root/proposals
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2020-01-03 16:05:07 -0800
committerBryan Newbold <bnewbold@robocracy.org>2020-01-03 16:05:07 -0800
commit3a57c35ddcf794d7211d1649e74a9917bd1c9495 (patch)
tree48f0c420d2048eeeec4add0b4523cb6a0a14dcfe /proposals
parentd5e2af24cb6563eca91407425cea9b808a7d691c (diff)
downloadfatcat-3a57c35ddcf794d7211d1649e74a9917bd1c9495.tar.gz
fatcat-3a57c35ddcf794d7211d1649e74a9917bd1c9495.zip
proposals: standardize a bit
Diffstat (limited to 'proposals')
-rw-r--r--proposals/20190509_v03_schema_tweaks.md (renamed from proposals/20190509_schema_tweaks.md)4
-rw-r--r--proposals/20190510_editgroup_endpoint_prefix.md2
-rw-r--r--proposals/20190510_release_ext_ids.md2
-rw-r--r--proposals/20190514_fatcat_identifiers.md2
-rw-r--r--proposals/20190911_search_query_parsing.md8
-rw-r--r--proposals/20190911_v04_schema_tweaks.md4
-rw-r--r--proposals/20191018_bigger_db.md4
-rw-r--r--proposals/20200103_py37_refactors.md (renamed from proposals/2020_py37_refactors.md)0
-rw-r--r--proposals/README.md11
9 files changed, 34 insertions, 3 deletions
diff --git a/proposals/20190509_schema_tweaks.md b/proposals/20190509_v03_schema_tweaks.md
index 7e372959..150ce525 100644
--- a/proposals/20190509_schema_tweaks.md
+++ b/proposals/20190509_v03_schema_tweaks.md
@@ -1,4 +1,6 @@
+Status: implemented
+
# SQL (and API) schema changes
Intend to make these changes at the same time as bumping OpenAPI schema from
@@ -139,4 +141,4 @@ Do these as separate commits, after merging back in to master, for v0.3:
`release_month`: apprently pretty common to know the year and month but not
date. I have avoided so far, seems like unnecessary complexity. Could start
-as an `extra_json` field?
+as an `extra_json` field? NOT IMPLEMENTED
diff --git a/proposals/20190510_editgroup_endpoint_prefix.md b/proposals/20190510_editgroup_endpoint_prefix.md
index f517383b..6794266e 100644
--- a/proposals/20190510_editgroup_endpoint_prefix.md
+++ b/proposals/20190510_editgroup_endpoint_prefix.md
@@ -1,4 +1,6 @@
+Status: implemented
+
# Editgroup API Endpoint Prefixes
In summary, change the API URL design such that entity mutations (create,
diff --git a/proposals/20190510_release_ext_ids.md b/proposals/20190510_release_ext_ids.md
index 1d2b912a..8953448c 100644
--- a/proposals/20190510_release_ext_ids.md
+++ b/proposals/20190510_release_ext_ids.md
@@ -1,4 +1,6 @@
+Status: implemented
+
# Release External ID Refactor
Goal is to make the external identifier "namespace" (number of external
diff --git a/proposals/20190514_fatcat_identifiers.md b/proposals/20190514_fatcat_identifiers.md
index 941775e3..325e48f5 100644
--- a/proposals/20190514_fatcat_identifiers.md
+++ b/proposals/20190514_fatcat_identifiers.md
@@ -1,4 +1,6 @@
+Status: brainstorm
+
Fatcat Identifiers
=======================
diff --git a/proposals/20190911_search_query_parsing.md b/proposals/20190911_search_query_parsing.md
index 1e656fef..f1fb0128 100644
--- a/proposals/20190911_search_query_parsing.md
+++ b/proposals/20190911_search_query_parsing.md
@@ -1,5 +1,7 @@
-status: work-in-progress
+Status: brainstorm
+
+## Search Query Parsing
The default "release" search on fatcat.wiki currently uses the elasticsearch
built-in `query_string` parser, which is explicitly not recommended for
@@ -20,3 +22,7 @@ A couple search issues this would help with:
In the near future, we may also create a fulltext search index, which will have
it's own issues.
+
+## Tech Changes
+
+If we haven't already, should also switch to using elasticsearch client library.
diff --git a/proposals/20190911_v04_schema_tweaks.md b/proposals/20190911_v04_schema_tweaks.md
index ce885b95..eaf39474 100644
--- a/proposals/20190911_v04_schema_tweaks.md
+++ b/proposals/20190911_v04_schema_tweaks.md
@@ -1,5 +1,7 @@
-status: work-in-progress
+Status: planned
+
+## Schema Changes for v0.4 Release
Proposed schema changes for next fatcat iteration (v0.4? v0.5?).
diff --git a/proposals/20191018_bigger_db.md b/proposals/20191018_bigger_db.md
index cd5f6e7b..7a5216d0 100644
--- a/proposals/20191018_bigger_db.md
+++ b/proposals/20191018_bigger_db.md
@@ -1,4 +1,8 @@
+Status: brainstorm
+
+## Catalog Database Scaling
+
How can we scale the fatcat backend to support:
- one billion release entities
diff --git a/proposals/2020_py37_refactors.md b/proposals/20200103_py37_refactors.md
index f0321b33..f0321b33 100644
--- a/proposals/2020_py37_refactors.md
+++ b/proposals/20200103_py37_refactors.md
diff --git a/proposals/README.md b/proposals/README.md
new file mode 100644
index 00000000..5e6747b1
--- /dev/null
+++ b/proposals/README.md
@@ -0,0 +1,11 @@
+
+This folder contains proposals for larger changes to the fatcat system. These
+might be schema changes, new projects, technical details, etc. Any change which
+is large enough to require planning and documentation.
+
+Each should be tagged with a date first drafted, and labeled with a status:
+
+- brainstorm: just putting ideas down; might not even happen
+- planned: commited to happening, but not started yet
+- work-in-progress: currently being worked on
+- implemented: completed, merged to master/production/live