Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change terminology Sleeping to Archived #221

Merged
merged 3 commits into from
Aug 7, 2024
Merged

Change terminology Sleeping to Archived #221

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0670af
Change terminology `Sleeping` to `Archived`
avinassh Aug 6, 2024
c0f1753
Update the openapi spec to use `archived` field
avinassh Aug 6, 2024
50ead8d
Add redirects for old /wakeup paths
avinassh Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2232,7 +2232,7 @@
},
"sleeping": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@athoscouto @avinassh do we plan to update the API too? Otherwise it’s just as confusing if we don’t.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not made changes to the API to keep backward compatibility.

I will send a follow up patch and update the API spec and replace sleeping with archived. On the API server, I will send both the fields. WDYT?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sending both fields sounds good to me. We can then update the docs to use archived and never speak of sleeping again 😂

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is sleeping

"type": "boolean",
"description": "The current status of the database. If `true`, the database is sleeping and requires a manual wakeup.",
"description": "The current status of the database. If `true`, the database is archived and requires a manual unarchive step.",
"example": false
}
}
Expand Down Expand Up @@ -2542,7 +2542,7 @@
},
"archived": {
"type": "boolean",
"description": "Groups on the free tier go to sleep after some inactivity.",
"description": "Groups on the free tier get archived after some inactivity.",
"example": false
}
}
Expand Down
10 changes: 5 additions & 5 deletions cli/db/wakeup.mdx
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to rename this path? Also, we should add a redirect for the old pages to the new ones. I think mint.json has an example of this, on my phone though so unable to test locally.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just renamed to keep it consistent. However, you are right about redirects and I missed that. I have added redirects now. However, if you want to keep the old path names, then I can revert those changes.

I am having some issue with node locally and not able to run it. I will report back if I get it to working.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes look good!

Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: db wakeup
sidebarTitle: wakeup
title: db unarchive
sidebarTitle: unarchive
---

You can wakeup inactive databases by running the following command:
You can unarchive inactive databases by running the following command:

```bash
turso db wakeup <database-name>
turso db unarchive <database-name>
```

<Info>

Databases go to sleep after 10 days of inactivity for users on a free plan &mdash; [learn more](/features/scale-to-zero).
Databases get archived after 10 days of inactivity for users on a free plan &mdash; [learn more](/features/scale-to-zero).

</Info>
16 changes: 16 additions & 0 deletions cli/group/unarchive.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: group unarchive
sidebarTitle: unarchive
---

You can unarchive inactive databases by running the following command:

```bash
turso group unarchive <group-name>
```

<Info>

Databases get archived after 10 days of inactivity for users on a free plan &mdash; [learn more](/features/scale-to-zero).

</Info>
16 changes: 0 additions & 16 deletions cli/group/wakeup.mdx
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion features/scale-to-zero.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ When a request is made, the databases automatically scale back up to one. There

<Info>

[Database groups](/concepts#groups) with extended inactivity (**10 days**) will require a manual "wake up" operation using the [CLI](/cli/group/wakeup) or API.
[Database groups](/concepts#groups) with extended inactivity (**10 days**) will require a manual "unarchive" operation using the [CLI](/cli/group/unarchive) or API.

</Info>
4 changes: 2 additions & 2 deletions mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@
}
]
},
"cli/db/wakeup"
"cli/db/unarchive"
]
},
"cli/dev",
Expand All @@ -211,7 +211,7 @@
"cli/group/tokens/invalidate"
]
},
"cli/group/wakeup"
"cli/group/unarchive"
]
},
{
Expand Down