Add some extra details to docs #82
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ninjaPixel
commented
Jul 8, 2024
Comment on lines
+124
to
+130
| - There should be no application state outside of CF Analytics Engine | ||
| - e.g. no additional relational database like MySQL, PostgreSQL, etc. | ||
| - That means no `users` table, no `sites` table, etc. | ||
| - This also means retention will be limited by what CF Analytics Engine provides. While it could be possible to stand up a "hit counter" for long-lived data (e.g. years), that would mean another database, which we will not pursue. | ||
| - We prioritize backwards compatibility | ||
| - New `metricsDataset` columns can be added, but old columns cannot be removed or renamed (they can however, be "forgotten"). | ||
| - That also means it's okay if a feature only works during a period where the data is active. |
There was a problem hiding this comment.
Changing * to - for unordered list items to make this section consistent with how the other unordered lists are declared. Note that there is no visual difference in the rendered document.
|
Hey, thanks for submitting. I just got back from a vacation but hoping to look at this soon. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #82 +/- ##
=======================================
Coverage 71.19% 71.19%
=======================================
Files 25 25
Lines 2638 2638
Branches 147 147
=======================================
Hits 1878 1878
Misses 755 755
Partials 5 5 ☔ View full report in Codecov by Sentry. |
|
@ninjaPixel Merged – thanks! |
benvinegar
added a commit
that referenced
this pull request
Dec 20, 2024
* docs: add some extra details to the Deployment section * docs: add screenshots * Fix typo --------- Co-authored-by: Ben Vinegar <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi, Ben! Thanks for creating this project. I heard you on the Syntax podcast and it was great timing as I was in the market for a self-hosted visitor analytics solution.
I hadn't used Cloudflare before and had a few minor stumbles when going through the
README, similar to issue #71 .I've added a little bit more detail to the
READMEand have added some screenshots too.I created a
/docsdirectory for the screenshots but I also realise that you load existing screenshots from an external URL. I'm happy to follow that pattern if you want to save my screenshots somewhere else.Thanks!