doc: Updated changelog and readme

Jelloeater · Sep 10, 2023 · f29e440 · f29e440
1 parent e3c3572
commit f29e440
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 99 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,106 +2,24 @@
 n.n.n / 2023-09-09
 ==================
 
-  * feat: Added poetry build option
-
-v0.1.0 / 2023-09-09
-===================
-
-  * Update README.md
-  * dev: Removed ARM build... timeing out
-  * fix: GH Actions plus Dockerfile user fix
-  * Finished updating template
-  * Added additional links
-  * Swapped to root user... meh
-  * Added missing chmod to file dir in Dockerfile
-  * wip: Working, but need to chmod 777 config dir
-  * doc: Added note on adding API endpoint link to gatus link bar
-  * fix: Fixed docker build order
-  * fix: Fixed config gen write permissions and DB updater
-  * Added logging
-  * Added API link
-  * dev: updated build order
-  * Updated dependcies
-  * doc: updated diagram
-  * fix: Added drop before insert, for refreshing data
-  * doc: Adde notes
-  * doc: Added DB create note
-  * Need to have domain, or when version changes they'll get a new entry, it will break badges
-  * fix: Fixed URL path and server desc
-  * wip: Config pull and gen is working, need to fix YAML syntax
-  * fix: You need to either create a DB first or use the default 'postgres' one... FUN! -_-
-  * fix: Fixed select query
-  * feat: fixed updaterq
-  * dev: Added image build
-  * dev: temp disable security
-  * wip: Need to debug update function
-  * wip: Started on update function
-  * wip: Added postgres driver to build, still need to finish updater
-  * Fixed to instance query
-  * doc: Added todo for PD alerting
-  * wip: started on data query
-  * Fixed import ^_^
-  * Added data mapping
-  * wip: Refactoring data insert into class method
-  * feat: Added better API endpoint check
-  * doc: Added todo
-  * wip: need to add new model
-  * dev: Added missing .env examples
-  * dev: Adde missing unit tests
-  * wip: ... it works?!?? Adding stuff to db in test moduele
-  * wip: working, but need to clean up data model
-  * fix: Refactored DB connection to only create live connection when called, NOT when module is loaded https://stackoverflow.com/questions/44984429/how-to-manage-a-peewee-database-in-a-separate-module
-  * test: Updated test suite
-  * fix: Fixed API server path
-  * Added template to security ignore
-  * FIX: Working api server now w/ un-versioned endpoint
-  * wip: Swagger API broken now :-(
-  * wip: Gatus working, need to fix api
-  * wip: update ports
-  * wip: Need to fix API router for docs
-  * Added HTTP for local testing
-  * Swapped DB config to Postgres
-  * Template refactor
-  * working w/ SQL lite
-  * Minor cleanup
-  * wip: Just need to get endpoint to generate properly, so close!
-  * doc: Added TODOq
-  * Fixed imports, needed to add env var back to docker file
-  * Fixed updater as well
-  * fix: FIXED BAD FastAPI version pin FML
-  * broken build
-  * wip: Docker build broken
-  * wip: File logging working, need to fix path next
-  * dev: Refactored classes for clarity
-  * wip: need to figure out log levels
-  * dev: Fixed class structure and unit tests
-  * wip: module refactor
-  * doc: Started on dependency graph
-  * wip: Started on seperate docker workers
-
-orig / 2023-07-06
-=================
 
-  * wip: Started on AIO repo
-  * doc: Added todo note
-  * wip: Started on DB for storage
-  * wip: Started on REST API pull
-  * wip: Started on REST API pull
-  * wip: Finished config gen
-  * Added UI template generator
-  * Added yaml var gen
-  * wip: App starts
-  * Initial Commit
 
-n.n.n / 2023-09-09
-==================
+v1.0.0 / 2023-09-09
+===================
 
-  * Added changelog
-  * feat: Added poetry build option
+  * doc: Update readme
+  * feat: Added number of servers to env var
+  * doc: Added prod deploy note
+  * feat: Added order by for top instances
+  * doc: readme update
+  * Added example Cloud init
 
 v0.1.0 / 2023-09-09
 ===================
 
+  * Updated build
+  * Added changelog
+  * feat: Added poetry build option
   * Update README.md
   * dev: Removed ARM build... timeing out
   * fix: GH Actions plus Dockerfile user fix
@@ -173,10 +91,6 @@ v0.1.0 / 2023-09-09
   * wip: module refactor
   * doc: Started on dependency graph
   * wip: Started on seperate docker workers
-
-orig / 2023-07-06
-=================
-
   * wip: Started on AIO repo
   * doc: Added todo note
   * wip: Started on DB for storage

diff --git a/Taskfile.yaml b/Taskfile.yaml
@@ -59,6 +59,7 @@ tasks:
             - poetry run pdoc3 {{.BUILD_DIR}} -o docs -f
             - poetry run pyreverse {{.BUILD_DIR}} -d docs
             - git add docs
+            - rm CHANGELOG.md
             - git-changelog -p -a -x >> CHANGELOG.md
             - git add CHANGELOG.md
     install:

diff --git a/docs/fedi_gatus/shared/db.md b/docs/fedi_gatus/shared/db.md
@@ -71,7 +71,7 @@ Classes
     `get_single_record(self) ‑> dict`
     :
 
-    `get_top_lemmy_instances(self, count=25) ‑> list[fedi_gatus.shared.db.Model]`
+    `get_top_lemmy_instances(self) ‑> list[fedi_gatus.shared.db.Model]`
     :
 
     `initialize(self)`

diff --git a/fedi_gatus/updater/data.py b/fedi_gatus/updater/data.py
@@ -1,4 +1,3 @@
-# TODO Pull data from https://api.fediverse.observer/
 import logging
 import os