Merge branch 'main' into label-report-prefill

This commit is contained in:
zak
2024-08-01 21:28:50 -07:00
committed by GitHub
3 changed files with 10 additions and 8 deletions

View File

@@ -47,24 +47,23 @@ type checking `task ui:check`
## Documentation
We use [Vitepress](https://vitepress.dev/) for the web documentation of homebox. Anyone is welcome to contribute the documentation if they wish.
Anyone is welcome to contribute the documentation if they wish. For documentation contributions, you only need Node.js and PNPM.
For documentation contributions, you only need Node.js and PNPM.
::: info Notes
- Languages are separated by folder (e.g `/en`, `/fr`, etc.)
- The Sidebar must be updated on a per language basis
+ The Sidebar must be updated on a per-language basis
- Each languages files can be named independently (slugs can match the language)
- Each language's files can be named independently (slugs can match the language)
- The `public/_redirects` file is used to redirect the default to english
- Redirects can also be configured per language by adding `Language=` after the redirect code
:::
## Branch Flow
We use the `main` branch as the development branch. All PRs should be made to the `main` branch form a feature branch.
We use the `main` branch as the development branch. All PRs should be made to the `main` branch from a feature branch.
To create a pull request you can use the following steps:
1. Fork the repo and create a new branch from `main`
2. If you added code that should be tested, add tests
3. If you've changed APIs update the documentation
3. If you've changed APIs, update the documentation
4. Ensure that the test suite and linters pass
5. Create your PR

View File

@@ -21,6 +21,8 @@ Homebox provides the option to auto-set asset IDs, this is the default behavior.
Example ID: `000-001`
To search for an Asset ID: type `#` in the search bar followed by the ID you're searching for, e.g. `#000-001`.
Asset IDs are partially managed by Homebox, but have a flexible implementation to allow for unique use cases. IDs are non-unique at the database level, so there is nothing stopping a user from manually setting duplicate IDs for various items. There are two recommended approaches to manage Asset IDs:
### 1. Auto Incrementing IDs

View File

@@ -42,8 +42,9 @@
<div class="border-t px-6 pb-3 border-gray-300 divide-gray-300 divide-y">
<DetailAction @action="modals.import = true">
<template #title>Import Inventory</template>
Imports the standard CSV format for Homebox. This will <b>not</b> overwrite any existing items in your
inventory. It will only add new items.
Imports the standard CSV format for Homebox. Without an <code>HB.import_ref</code> column, this will
<b>not</b> overwrite any existing items in your inventory, only add new items. Rows with an
<code>HB.import_ref</code> column are merged into existing items with the same import_ref, if one exists.
</DetailAction>
<DetailAction @action="getExportCSV()">
<template #title>Export Inventory</template>
@@ -104,7 +105,7 @@
middleware: ["auth"],
});
useHead({
title: "Homebox | Profile",
title: "Homebox | Tools",
});
const modals = ref({