mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
Merge pull request #2592 from kinglozzer/docs-localhost-urls
Update docs to consistently use http://localhost/ (fixes #1919)
This commit is contained in:
commit
68888f9105
@ -38,7 +38,7 @@ to a lot of development problems. Here are some specifics situations:
|
||||
## A SQL query fails with "Column not found" or "Table not found"
|
||||
|
||||
Whenever you change the model definitions in PHP (e.g. when adding a property to the [$db](api:DataObject::$db) array,
|
||||
creating a new page type), SilverStripe will need to update the database. Visiting `http://<my-domain>/dev/build` in
|
||||
creating a new page type), SilverStripe will need to update the database. Visiting `http://localhost/dev/build` in
|
||||
your browser runs a script that will check the database schema and update it as necessary. Putting `?flush=1` on the
|
||||
end makes sure that nothing that's linked to the old database structure will be carried over. If things aren't saving,
|
||||
pages aren't loading, or other random things aren't working it's possible that the database hasn't been updated to
|
||||
|
@ -15,7 +15,7 @@ See our [upgrade notes and changelogs](/changelogs) for release-specific informa
|
||||
* Identify system folders in your webroot (`cms`, `framework`, `sapphire` and any additional modules).
|
||||
* Delete existing system folders (or move them outside of your webroot)
|
||||
* Extract and replace system folders from your download (Deleting instead of "copying over" existing folders ensures that files removed from the new SilverStripe release are not persisting in your installation)
|
||||
* Visit http://yoursite.com/dev/build/?flush=1 to rebuild the website database
|
||||
* Visit http://localhost/dev/build/?flush=1 to rebuild the website database
|
||||
* Check if you need to adapt your code to changed PHP APIs
|
||||
* Check if you have overwritten any core templates or styles which might need an update
|
||||
* See [common-problems](common-problems) for a list of likely mistakes that could happen during an upgrade.
|
||||
|
@ -65,7 +65,7 @@ and avoid the change propagating to an older SilverStripe version.
|
||||
|
||||
### How do I change my interface language?
|
||||
|
||||
Once you've logged into the CMS, you should see a "profile"-link on the lower right corner (direct link: http://www.site.com/admin/myprofile). You can set the "interface language" from a dropdown which automatically includes all found translations (based on the files in the `/lang` folders).
|
||||
Once you've logged into the CMS, you should see the text "Hi <your name>" near the top left, you can click this to edit your profile ([direct link](http://localhost/admin/myprofile/)). You can then set the "interface language" from a dropdown which automatically includes all found translations (based on the files in the `/lang` folders).
|
||||
|
||||
### I've found a piece of untranslatable text
|
||||
|
||||
|
@ -79,7 +79,7 @@ left-join for robustness; if there is no matching record in Page, we can return
|
||||
|
||||
SilverStripe has a powerful tool for automatically building database schemas. We've designed it so that you should never have to build them manually.
|
||||
|
||||
To access it, visit http://<mysite>/dev/build?flush=1. This script will analyze the existing schema, compare it to what's required by your data classes, and alter the schema as required.
|
||||
To access it, visit http://localhost/dev/build?flush=1. This script will analyze the existing schema, compare it to what's required by your data classes, and alter the schema as required.
|
||||
|
||||
Put the ?flush=1 on the end if you've added PHP files, so that the rest of the system will find these new classes.
|
||||
|
||||
|
@ -54,7 +54,7 @@ All requests go through `main.`php, which sets up the environment and then hands
|
||||
main.php relies on `[api:Director]` to work out which controller should handle this request. `[api:Director]` will instantiate that
|
||||
controller object and then call `[api:Controller::run()]`.
|
||||
|
||||
In general, the URL is build up as follows: `page/action/ID/otherID` - e.g. http://www.mysite.com/mypage/addToCart/12.
|
||||
In general, the URL is build up as follows: `page/action/ID/otherID` - e.g. http://localhost/mypage/addToCart/12.
|
||||
This will add an object with ID 12 to the cart.
|
||||
|
||||
When you create a function, you can access the ID like this:
|
||||
|
@ -119,7 +119,7 @@ and whenever you upload or modify an Image through SilverStripe.
|
||||
If you encounter problems with images not appearing, or have mysteriously disappeared, you can try manually flushing the
|
||||
image cache.
|
||||
|
||||
http://www.mysite.com/images/flush
|
||||
http://localhost/dev/tasks/FlushGeneratedImagesTask
|
||||
|
||||
## API Documentation
|
||||
`[api:Image]`
|
||||
|
@ -58,7 +58,7 @@ Then activate your extension in your `[config.yml](/topics/configuration)` file.
|
||||
|
||||
This tells SilverStripe to add the CustomSiteConfig extension to the `[api:SiteConfig]` class.
|
||||
|
||||
After adding those two pieces of code, rebuild your database by visiting http://yoursite.com/dev/build and then reload
|
||||
After adding those two pieces of code, rebuild your database by visiting http://localhost/dev/build and then reload
|
||||
the admin interface. You may need to reload it with a ?flush=1 on the end.
|
||||
|
||||
You can define as many extensions for `[api:SiteConfig]` as you need. For example if you are developing a module you can define
|
||||
|
@ -56,8 +56,8 @@ Redirections](security#redirect_back_to_another_page_after_login) for more infor
|
||||
|
||||
| Site URL | | Action |
|
||||
| -------- | | ------ |
|
||||
| http://yoursite.com**/dev/build** | | Rebuild the entire database and manifest, see below for additional URL Variables |
|
||||
| http://yoursite.com**/admin/pages/publishall/** | | Publish all pages on the site
|
||||
| http://localhost**/dev/build** | | Rebuild the entire database and manifest, see below for additional URL Variables |
|
||||
| http://localhost**/admin/pages/publishall/** | | Publish all pages on the site
|
||||
|
||||
### /dev/build
|
||||
|
||||
|
@ -51,7 +51,7 @@ making any code changes to your controller.
|
||||
|
||||
<div class="warning" markdown='1'>
|
||||
SilverStripe automatically adds a URL routing entry based on the controller's class name,
|
||||
so a `MyController` class is accessible through `http://yourdomain.com/MyController`.
|
||||
so a `MyController` class is accessible through `http://localhost/MyController`.
|
||||
</div>
|
||||
|
||||
## Access Control
|
||||
@ -60,7 +60,7 @@ making any code changes to your controller.
|
||||
|
||||
All public methods on a controller are accessible by their name through the `$Action`
|
||||
part of the URL routing, so a `MyController->mymethod()` is accessible at
|
||||
`http://yourdomain.com/MyController/mymethod`. This is not always desireable,
|
||||
`http://localhost/MyController/mymethod`. This is not always desireable,
|
||||
since methods can return internal information, or change state in a way
|
||||
that's not intended to be used through a URL endpoint.
|
||||
|
||||
|
@ -25,7 +25,7 @@ case you need to drop down to the bare metal.
|
||||
## Generating the Database Schema
|
||||
|
||||
The SilverStripe database-schema is generated automatically by visiting the URL.
|
||||
`http://<mysite>/dev/build`
|
||||
`http://localhost/dev/build`
|
||||
|
||||
<div class="notice" markdown='1'>
|
||||
Note: You need to be logged in as an administrator to perform this command,
|
||||
|
@ -228,14 +228,14 @@ When caching a `<% loop %>` or `<% with %>` with `<%t params %>`. It is importan
|
||||
|
||||
To collect all the text in code and template files we have just to visit:
|
||||
|
||||
`http://<mysite>/dev/tasks/i18nTextCollectorTask`
|
||||
`http://localhost/dev/tasks/i18nTextCollectorTask`
|
||||
|
||||
Text collector will then read the files, build the master string table for each module where it finds calls to the
|
||||
underscore function, and tell you about the created files and any possible entity redeclaration.
|
||||
|
||||
If you want to run the text collector for just one module you can use the 'module' parameter:
|
||||
|
||||
`http://<mysite>/dev/tasks/i18nTextCollectorTask/?module=cms`
|
||||
`http://localhost/dev/tasks/i18nTextCollectorTask/?module=cms`
|
||||
|
||||
<div class="hint" markdown='1'>
|
||||
You'll need to install PHPUnit to run the text collector (see [testing-guide](/topics/testing)).
|
||||
|
@ -109,7 +109,7 @@ the YAML config, for example in `mysite/_config/config.yml`.
|
||||
theme: 'mythemename'
|
||||
|
||||
|
||||
Go to yoursite.com/?flush=1 and check it out. You should be using your new theme! Not really that awesome or amazing is
|
||||
Go to http://localhost?flush=1 and check it out. You should be using your new theme! Not really that awesome or amazing is
|
||||
it? Next we need to add some CSS Magic!
|
||||
|
||||
See [Templates](/reference/themes) for more information about templates.
|
||||
|
@ -16,7 +16,7 @@ as a .tar.gz file.
|
||||
2. Change the site to the theme. You can do this either by:
|
||||
- Altering the `SSViewer.theme` setting in your `[config.yml](/topics/configuration)`
|
||||
- changing the theme in the Site Configuration panel in the CMS
|
||||
3. Visit your homepage with ?flush=all appended to the URL. `http://yoursite.com?flush=all`
|
||||
3. Visit your homepage with ?flush=all appended to the URL. `http://localhost?flush=all`
|
||||
|
||||
## Developing your own theme
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user