diff --git a/API/NoSQL.md b/docs/API/NoSQL.md similarity index 100% rename from API/NoSQL.md rename to docs/API/NoSQL.md diff --git a/API/SQL.md b/docs/API/SQL.md similarity index 97% rename from API/SQL.md rename to docs/API/SQL.md index 3f15ee8..07a09ce 100644 --- a/API/SQL.md +++ b/docs/API/SQL.md @@ -295,7 +295,9 @@ __Arguments__ ### all(sql, [params,] callback) -Execute a select statement +Execute a select statement, even in dry run mode. Attention, only use this if +you know what you're doing. This can cause you issues if you're utilizing +the dry-run mode for testings. To execute sql queries always use runSql! __Arguments__ diff --git a/API/generic datatypes.md b/docs/API/generic datatypes.md similarity index 100% rename from API/generic datatypes.md rename to docs/API/generic datatypes.md diff --git a/Developers/contributing.md b/docs/Developers/contributing.md similarity index 100% rename from Developers/contributing.md rename to docs/Developers/contributing.md diff --git a/Developers/running tests.md b/docs/Developers/running tests.md similarity index 100% rename from Developers/running tests.md rename to docs/Developers/running tests.md diff --git a/Getting Started/configuration.md b/docs/Getting Started/configuration.md similarity index 94% rename from Getting Started/configuration.md rename to docs/Getting Started/configuration.md index e4ccf26..399b948 100644 --- a/Getting Started/configuration.md +++ b/docs/Getting Started/configuration.md @@ -52,6 +52,8 @@ You can also specify environment variables in your config file by using a specia In this case, db-migrate will search your environment for variables called `PRODUCTION_USERNAME` and `PRODUCTION_PASSWORD`, and use those values for the corresponding configuration entry. +If you use the [dotenv](https://www.npmjs.com/package/dotenv) package to manage environment variables, db-migrate will automatically load it. + Note that if the settings for an environment are represented by a single string that string will be parsed as a database URL. You can pass the -e or --env option to db-migrate to select the environment you want to run migrations against. The --config option can be used to specify the path to your database.json file if it's not in the current working directory. @@ -81,4 +83,4 @@ If you use MySQL, to be able to use multiple statements in your sql file, you ha "multipleStatements": true } } -``` \ No newline at end of file +``` diff --git a/Getting Started/installation.md b/docs/Getting Started/installation.md similarity index 100% rename from Getting Started/installation.md rename to docs/Getting Started/installation.md diff --git a/Getting Started/the commands.md b/docs/Getting Started/the commands.md similarity index 100% rename from Getting Started/the commands.md rename to docs/Getting Started/the commands.md diff --git a/Getting Started/usage.md b/docs/Getting Started/usage.md similarity index 100% rename from Getting Started/usage.md rename to docs/Getting Started/usage.md diff --git a/help.md b/docs/help.md similarity index 100% rename from help.md rename to docs/help.md diff --git a/index.md b/docs/index.md similarity index 100% rename from index.md rename to docs/index.md diff --git a/docs/search.html b/docs/search.html new file mode 100644 index 0000000..742c01c --- /dev/null +++ b/docs/search.html @@ -0,0 +1,9 @@ +

Search Results

+ +
+ +
+ +
+ Sorry, page not found. +
diff --git a/mkdocs.yml b/mkdocs.yml index 883ed1c..17f2d4c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,16 +1,20 @@ site_name: db-migrate -pages: -- [index.md, Home] -- [help.md, 'Helping db-migrate'] -- [Getting Started/installation.md, 'Getting Started', Installation] -- [Getting Started/configuration.md, 'Getting Started', Configuration] -- [Getting Started/the commands.md, 'Getting Started', 'The Commands'] -- [Getting Started/usage.md, 'Getting Started', Usage] -- [API/generic datatypes.md, 'API', 'Generic Datatypes'] -- [API/SQL.md, 'API', 'SQL API'] -- [API/NoSQL.md, 'API', 'NoSQL API'] -- [Developers/running tests.md, 'Developers', 'Running Tests'] -- [Developers/contributing.md, 'Developers', Contributing] -docs_dir: . +nav: + - Search through the docs: search.html + - Home: index.md + - "Helping db-migrate": help.md + - Getting Started: + - Installation: Getting Started/installation.md + - Configuration: Getting Started/configuration.md + - "The Commands": Getting Started/the commands.md + - Usage: Getting Started/usage.md + - API: + - "Generic Datatypes": API/generic datatypes.md + - "SQL API": API/SQL.md + - "NoSQL API": API/NoSQL.md + - Developers: + - "Running Tests": Developers/running tests.md + - Contributing: Developers/contributing.md +docs_dir: docs repo_url: https://github.com/db-migrate/english-docs theme: readthedocs diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..591f7c0 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +mkdocs==1.0.4