MTC docs (#186)

* fix build * MTC docs * Update mtc.md
scarf-sh · Dec 30, 2024 · b1bceb2 · b1bceb2
1 parent 2750245
commit b1bceb2
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 190 deletions.
diff --git a/README.md b/README.md
@@ -23,16 +23,6 @@ pip install -r requirements.txt
 mkdocs serve
 ```
 
-#### [devenv.sh](https://devenv.sh)
-
-```bash
-# drop into a shell with dependencies installed
-devenv shell
-
-# run the dev server
-devenv up
-```
-
 ### Deploy
 
 GitHub Actions are configured for this repository to deploy changes on every update to the master branch.

diff --git a/devenv.lock b/devenv.lock
diff --git a/devenv.nix b/devenv.nix
diff --git a/devenv.yaml b/devenv.yaml
diff --git a/docs/mtc.md b/docs/mtc.md
@@ -0,0 +1,38 @@
+# Monthly Tracked Companies (MTCs)
+
+Scarf identifies which companies are viewing your documents, downloading your packages, or executing your software, and tracks their activity across the organization. These are referred to as Monthly Tracked Companies (MTCs). Scarf enriches IP addresses with several metadata sources to provide the most accurate data possible.
+
+## Consumption of MTCs
+MTCs are consumed any time a company is seen for the first time in a given month. For example, if you have purchased 100 MTCs, you will see the first 100 companies that interact with your open source and no further companies will be surfaced for the remainder of the month.
+
+NOTE: There is no way to predict which companies will surface, or how quickly. Companies are surfaced in the order they are seen, until your MTC limit is reached.
+
+Scarf will always show you the total number of companies interacting with your project at the bottom of the Company Insights page. You can update your plan's MTC quota in your Organization settings. You can also track your MTC usage by day in your Organization settings.
+
+## Match Feedback
+Match Feedback allows you to confirm, deny, or fix your company matches. Companies marked with negative match feedback will not consume MTCs the following month.
+
+![No company feedback on file  If you](https://github.com/user-attachments/assets/72389329-b857-45b2-9450-481e45badc39)
+
+## FAQ
+Q: How do I know how much of my MTC quota I’ve used?
+A: You will see a count of the currently used MTCs at the bottom of the Company Insights page.
+
+![AD_4nXcJB4vyNmsG0v4KrNp82PMYOXX86ixbaBe2Yqn5C1uJ471Lt0eNeATdBn-GHOSjVVK19DSze9bOT75QA5QpJYSGlqGsJ1nrS4Jd050W_KcBITvGQCjOt7gL](https://github.com/user-attachments/assets/641e30b6-293d-415c-add9-4e0d772a88a6)
+
+It is also available on the Organization settings page.
+
+![1,048](https://github.com/user-attachments/assets/191f5115-c31d-4acd-965c-475fb41773f5)
+![MTC Consumption is based on the number of matched companies in a 30 day period  This chart shows the](https://github.com/user-attachments/assets/b749dd9e-d269-4631-a0fa-8680057b4408)
+
+
+Q: What if I want to see more companies?
+A: You can always increase the number of MTCs on your account to see more. If you are using the Scarf Starter package you can add up to 250 MTCs by going into your account Settings > Billing/Subscription and adding more. If you are using any other Scarf package, contact sales or your customer success manager for more information.
+
+![Upgrade your MTC limit](https://github.com/user-attachments/assets/e1c121d2-d5dc-434d-a39d-bdeca9e1d694)
+
+Q: Why do I occasionally see fewer companies on my Scarf home page than I am allocated?
+A: Scarf’s home page will always show you metrics from the last 30 days. Because the MTC quota resets at the beginning of each month, there is sometimes a perceived “gap” in the number of companies shown on the home page in the “Events by Company” chart. While the home page is designed to provide an “at-a-glance” overview of overall activity, it may be easier to get the full picture of the companies present within a given period (within the MTC quota) by visiting the Company Insights page.
+
+Q: When I look at the results on the Company Insights page for last month (using the custom time range), I see that 3,045 of my 5,000 allocated companies are being shown. Why do I not see all 5,000 of my MTCs?
+A: Scarf displays the companies present at that point in time that are also present in the current month’s quota. In other words, 3,045 of the companies present last month are also in this month’s data. The remaining companies we matched last month are inactive in the current month’s data. As companies interact with your project in that given month, they will be added to the count until you reach your full MTC quota.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -44,7 +44,9 @@ nav:
 - getting-started-checklist.md
 - quick-start.md
 - gateway.md
-- organizations.md
+- Organizations:
+  - Setting up your organization: organizations.md
+  - mtc.md
 - packages.md
 - package-analytics.md
 - custom-telemetry.md

diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,5 @@
-mkdocs==1.4.2
-mkdocs-material==9.0.6
+mkdocs>=1.4.2
+mkdocs-material>=9.0.6
 mkdocs_custom_fences
 mkdocs-render-swagger-plugin>=0.0.4
+pyyaml>=6.0