Add some help text to new project form, etc.

This commit is contained in:
Lance Edgar 2020-09-06 15:33:19 -05:00
parent cf613ab34a
commit f8d9b0803c

View file

@ -25,23 +25,28 @@
<div class="card-content"> <div class="card-content">
<div class="content"> <div class="content">
<b-field horizontal label="Name"> <b-field horizontal label="Name"
message="The &quot;canonical&quot; name generally used to refer to this project">
<b-input name="name" v-model="rattail.name"></b-input> <b-input name="name" v-model="rattail.name"></b-input>
</b-field> </b-field>
<b-field horizontal label="Slug"> <b-field horizontal label="Slug"
message="Used for e.g. naming the project source code folder">
<b-input name="slug" v-model="rattail.slug"></b-input> <b-input name="slug" v-model="rattail.slug"></b-input>
</b-field> </b-field>
<b-field horizontal label="Organization"> <b-field horizontal label="Organization"
message="For use with &quot;branding&quot; etc.">
<b-input name="organization" v-model="rattail.organization"></b-input> <b-input name="organization" v-model="rattail.organization"></b-input>
</b-field> </b-field>
<b-field horizontal label="Python Project Name"> <b-field horizontal label="Package Name for PyPI"
message="It&apos;s a good idea to use org name as namespace prefix here">
<b-input name="python_project_name" v-model="rattail.python_project_name"></b-input> <b-input name="python_project_name" v-model="rattail.python_project_name"></b-input>
</b-field> </b-field>
<b-field horizontal label="Python Package Name"> <b-field horizontal label="Package Name in Python"
:message="`For example, ~/src/${'$'}{rattail.slug}/${'$'}{rattail.python_package_name}/__init__.py`">
<b-input name="python_name" v-model="rattail.python_package_name"></b-input> <b-input name="python_name" v-model="rattail.python_package_name"></b-input>
</b-field> </b-field>
@ -56,21 +61,25 @@
<div class="card-content"> <div class="card-content">
<div class="content"> <div class="content">
<b-field horizontal label="Has Rattail DB"> <b-field horizontal label="Has Rattail DB"
message="Note that a DB is required for the Web App">
<b-checkbox name="has_db" <b-checkbox name="has_db"
v-model="rattail.has_rattail_db" v-model="rattail.has_rattail_db"
native-value="true"> native-value="true">
</b-checkbox> </b-checkbox>
</b-field> </b-field>
<b-field horizontal label="Extends Rattail DB Schema"> <b-field horizontal label="Extends Rattail DB Schema"
message="For adding custom tables/columns to the core schema">
<b-checkbox name="extends_db" <b-checkbox name="extends_db"
v-model="rattail.extends_rattail_db_schema" v-model="rattail.extends_rattail_db_schema"
native-value="true"> native-value="true">
</b-checkbox> </b-checkbox>
</b-field> </b-field>
<b-field horizontal label="Uses Rattail Batch Schema"> <b-field horizontal label="Uses Rattail Batch Schema"
v-show="false"
message="Needed for &quot;dynamic&quot; (e.g. import/export) batches">
<b-checkbox name="has_batch_schema" <b-checkbox name="has_batch_schema"
v-model="rattail.uses_rattail_batch_schema" v-model="rattail.uses_rattail_batch_schema"
native-value="true"> native-value="true">
@ -95,7 +104,9 @@
</b-checkbox> </b-checkbox>
</b-field> </b-field>
<b-field horizontal label="Has Tailbone Web API"> <b-field horizontal label="Has Tailbone Web API"
v-show="false"
message="Needed for e.g. Vue.js SPA mobile apps">
<b-checkbox name="has_web_api" <b-checkbox name="has_web_api"
v-model="rattail.has_tailbone_web_api" v-model="rattail.has_tailbone_web_api"
native-value="true"> native-value="true">
@ -113,28 +124,32 @@
<div class="card-content"> <div class="card-content">
<div class="content"> <div class="content">
<b-field horizontal label="Integrates w/ Catapult"> <b-field horizontal label="Integrates w/ Catapult"
message="Add schema, import/export logic etc. for ECRS Catapult">
<b-checkbox name="integrates_catapult" <b-checkbox name="integrates_catapult"
v-model="rattail.integrates_with_catapult" v-model="rattail.integrates_with_catapult"
native-value="true"> native-value="true">
</b-checkbox> </b-checkbox>
</b-field> </b-field>
<b-field horizontal label="Integrates w/ CORE-POS"> <b-field horizontal label="Integrates w/ CORE-POS"
v-show="false">
<b-checkbox name="integrates_corepos" <b-checkbox name="integrates_corepos"
v-model="rattail.integrates_with_corepos" v-model="rattail.integrates_with_corepos"
native-value="true"> native-value="true">
</b-checkbox> </b-checkbox>
</b-field> </b-field>
<b-field horizontal label="Integrates w/ LOC SMS"> <b-field horizontal label="Integrates w/ LOC SMS"
v-show="false">
<b-checkbox name="integrates_corepos" <b-checkbox name="integrates_corepos"
v-model="rattail.integrates_with_locsms" v-model="rattail.integrates_with_locsms"
native-value="true"> native-value="true">
</b-checkbox> </b-checkbox>
</b-field> </b-field>
<b-field horizontal label="Has DataSync Service"> <b-field horizontal label="Has DataSync Service"
v-show="false">
<b-checkbox name="has_datasync" <b-checkbox name="has_datasync"
v-model="rattail.has_datasync_service" v-model="rattail.has_datasync_service"
native-value="true"> native-value="true">
@ -212,7 +227,7 @@
ThisPageData.rattail = { ThisPageData.rattail = {
name: "Okay-Then", name: "Okay-Then",
slug: "okay-then", slug: "okay-then",
organization: "Acme", organization: "Acme Foods",
python_project_name: "Acme-Okay-Then", python_project_name: "Acme-Okay-Then",
python_package_name: "okay_then", python_package_name: "okay_then",
has_rattail_db: true, has_rattail_db: true,
@ -224,7 +239,7 @@
integrates_with_catapult: false, integrates_with_catapult: false,
integrates_with_corepos: false, integrates_with_corepos: false,
integrates_with_locsms: false, integrates_with_locsms: false,
uses_fabric: false, uses_fabric: true,
} }
ThisPageData.byjove = { ThisPageData.byjove = {