Platform.sh documentation. Templates available at https://github.com/platformsh-templates/
Home Page: https://docs.platform.sh/
License: Creative Commons Attribution Share Alike 4.0 International
I recall seeing a sentence somewhere in the platform.sh docs which said something like "If the project has a project file then the project will be built in project mode", which was very confusing.
Project seems to be used as a verb and an adjective, and in any case it's a standard English word which has broader meanings outside of platform.sh
If we had a glossary, project, project file, project mode could have their own entries.
On https://docs.platform.sh/overview/tools.html#ssh, we link to RSA wiki page. The link is broken https://en.wikipedia.org/wiki/RSA_(cryptosystem. This does not happen in GitHub markdown renderer.
404
https://docs.platform.sh/reference/cache/#enable-http-caching
This link is reference at :
https://platform.sh/blog/new-features/
HTTP caching
Read more about configuring the cache on our documentation.
There are a few of these inconsistencies, for example:
The docs should read something like:
Add an environment variable with the drupal: prefix on it so that it can get added to the $conf var in your Drupal installation. Example:
drupal:cookie_domain
yourdomain.com
In settings.php add this code:
if (!empty($conf['cookie_domain'])) {
$cookie_domain=$conf['cookie_domain'];
}
I was recently talking to support about why an application gets deployed into /app or sometimes /app/public
This is actually controlled by the document_root setting in the .platform.app.yaml. If the document_root is set to /, it will move the application to /app/public and use that as the root to allow for the private mounts to be kept private. In the case of your stats-tracking project it's doing this because there is no .platform.app.yaml so it is using the defaults.
Best,
Brad
This information should be added to: https://docs.platform.sh/user_guide/reference/platform-app-yaml.html
When testing git submodules with a multi application setup as described here I had several issues which were not easy to debug.
When I removed the git structure with submodules and commited all files to the main directory instead of submodules it was possible to push the application.
Maybe this is a bug or git submodules do not work with multi apps.
It is also possible that I did some configs wrong which would be odd since it works with the same configs when not using submodules.
The error:
Validating configuration files.
E: Error parsing configuration files:
- http://docs.{default}/: Upstream 'docs:php' of route 'http://docs.{default}/' doesn't exist.
To [email protected]:63nps64z7mely.git
I would like to write a section documenting Drupal 6, redis and cache_backport - should this be a separate section in the FAQ for redis or should I simplly append it to the D7 FAQ at https://docs.platform.sh/toolstacks/php/drupal/redis.html
This file is not used and should probably be removed: https://github.com/platformsh/platformsh-docs/tree/master/reference/services.
This part is used: https://github.com/platformsh/platformsh-docs/blob/master/reference/services-yaml.md#supported-services
See ticket #3662
Line 24 says: .platform.application.yaml
Line 26 says: .platform.app.yaml
Installing Wordpress plugins through composer doesn't work.
Even after adding:
"extra": { "wordpress-install-dir": "wp", "installer-paths": { "wp/wp-content/plugins/{$name}/": ["type:wordpress-plugin"] } },
The plugins are missing after the deployment. After doing some digging I found this:
johnpbloch/wordpress-core-installer#11
on
https://github.com/platformsh/platformsh-docs/blob/blackfire/integration/webhooks.rst
we say "This command returns the Payload URL that you need to paste on your Github repository".
Current output:
platform integration:set --type=github --token=c84258....aa8e34 --repository=OriPekelman/apidays-2014-git-as-hypermedia
Integration mprqvhu5q756y created for github
Repository: OriPekelman/apidays-2014-git-as-hypermedia
Build PRs: yes
Fetch branches: yes
may be a CLI issue
The links "Edit on Github" and "Show on Github" are not redirecting to the correct Github.
Tell people what it is and what they can find there (i.e. working examples of a variety of applications)
The documentation for how to set up a domain name for a site is slightly confusing and could do with a tidy.
The instructions to push an empty commit should perhaps be added to Troubleshooting:
$ git commit --allow-empty -m 'force redeploy'
$ git push origin master
Since each language has its specific URL on its specific subdomain, which is stored in the database, if you change the environment (branching or merging), you'll break URLs on that environment.
To bypass that, you can create a custom Drush command which you run in your post-deploy hook. This command could override the domain of each language to match:
[LANGUAGE_CODE]-[PLATFORM_ENVIRONMENT]-[PLATFORM_PROJECT].[CLUSTER].platform.shFor Drupal:
"Minimum cache lifetime should stay at "
"Expiration of cached pages"
The section in the README about conributing to the documentation doesn't make sense.
This page could be improved: https://docs.platform.sh/administration/web/environments.html#hierarchy
The command is only available through the CLI, using platform e:info parent <new parent>.
https://docs.platform.sh/reference/environment-variables/
I think this page is confusing - it conflates the system environment variables with the actual 'variables' environment variables if you see what I mean (PLATFORM_* vs PLATFORM_VARIABLES).
Perhaps we should just spell out that there are these two types of 'variable' with distinct meanings, and explain why.
name: phpsymfony
name: phpdrupal
In .platform/routes.yaml you define the upstream which will serve your app:
"http://{default}/symfony":
type: upstream
upstream: "phpsymfony:php"
"http://{default}/":
type: upstream
upstream: « phpdrupal:php"
A few issues in one:
If i get it right, the redis server must also be enabled in .platform/services.yml
on https://docs.platform.sh/user_guide/reference/toolstacks/php/drupal/redis-drupal-7.html
in the settings.php section it's not totally clear how this works:
Currently there's one line before the settings.local include setting which connector to use,
And then some more lines after the include. Amongst it one about the connector too, but it does not say to adjust there to the used connector, which i think i should.
Can't i just as well put that code in settings.local.php to use redis eg. in production only?
The article only promotes using environment variables for that.
Also, the drupal-6 version tells how to check if redis is running, the D7 version is missing that.
Hi,
I'm just going through the process of importing an existing Drupal site into platform and I think the the docs are a bit out of date:
Page Order
Since July 2016 you can't actually push your code to platform without having the configuration files already created and committed to the repo. However, this step in the tutorial comes before the configuration step which is going to be confusing for users following step-by-step (like me).
Additionally the image in the "Import your codebase" step does not quite match what I'm seeing. This isn't that big a deal but it did lead me to consider that maybe the documentation was out of date.
The "Public" or "Web" subdirectory
Initially reading through the docs (the drupal tutorial and the main docs), I was confused by various references to a "public" directory. As it turns out I think platform used to automatically move the application files into a public subdirectory, but that changed sometime earlier this year.
However, it's still required that your code be in a subdirectory which isn't actually mentioned in the "import your codebase" step. I think it should be mentioned earlier in the docs (maybe even as a prerequisite?) that your Drupal code cannot be at the root of the repository as many people's existing codebases may not be setup this way.
Thanks!
Reported by Florian Huber:
I have just recognized that on https://docs.platform.sh/user_guide/reference/services-yaml.html there is an wrong link to the .platform.app.yaml (used URL: https://docs.platform.sh/user_guide/reference/reference/platform-app-yaml.html).
If the file name is having unicode character and running rsync without --iconv=utf-8-mac,utf-8 will get wrong file name on the application container.
This issue is recently hit by a customer. Shall we add a note to our rsync examples?
This link from the deprecated log message: https://docs.platform.sh/reference/upgrade/#changes-in-2015.7 is broken.
It should redirect to: https://docs.platform.sh/discover/reference/upgrade/index.html
CNAME, ALIAS, ANAME and their impact on other DNS records (namely MX).
Developers over the age of 40 (or so) need to be able to read the user guide ;-)
The burger button in the top-left is coloured #ccc on a white background, so it's hard to know that a table of contents is available. Additionally it has a low-contrast focus outline (also #ccc).
Can we darken this to at least #757575 so it passes WCAG AA contrast requirements?
When page is not found, extract terms to be used on search on a newly created 404 page
404
https://docs.platform.sh/web-ui/
404
https://docs.platform.sh/web-ui/configure-project/#domains
This link is used by Domain help link
https://us.platform.sh/projects/[code]/edit
As reported in the examples here: https://github.com/platformsh/platformsh-examples/issues/40, the application name and its relations to the routes and services is confusing.
We should update code snippets with a proper name.
We've now embedded the SSH key upload in the Platform.sh UI.
We should update this section: https://docs.platform.sh/use-platform/use-SSH/#add-your-ssh-key-to-your-platform-account
The current documentation lets one think that this is valid:
crons:
spec: ...
cmd: ...
While in reality, this is necessary:
crons:
foo:
spec: ...
cmd: ...
Where foo is the name of the cron.
l just found out that a command that worked fine on platform ssh was not working on cron, by looking at cron.log I found out that it was run on dash, so I fixed it accordingly.
This should be documented probably on the cron section, that is run with dash and that you can use that shell within the container to try it out.
We now support wildcard routes.
In the past we had :
https://docs.platform.sh/drupal/guides/type/php/drupal/setup/get-started.html
now , current Drupal developement in Platform documentation seems to me incomplete/missing ? :
https://docs.platform.sh/frameworks/drupal7/developing-with-drupal.html
Given how often the docs change and how the docs have proliferated over the past few months, it would really make sense to put the docs in an environment that encouraged and made changes easier instead of harder.
So, please, let's put the docs in a Wiki. This would make contributions easier by not requiring knowledge of Git.
Looking at https://docs.platform.sh/languages/php.html, it's indicated that mcrypt is "enabled by default". However, when tinkering with Platform.sh I found that I had to specify it explicitly (was using PHP 7.0) or I got an error when Composer ran about mcrypt not being available.
I'd be happy to correct the docs via a PR, but I'm not sure whether this is a bug in the platform or the docs.
Relevant tidbits:
- cakephp/cakephp 2.8.6 requires ext-mcrypt * -> the requested PHP extension mcrypt is missing from your system.
To enable extensions, verify that they are enabled in those .ini files:
- /etc/php/7.0/cli/php.ini
You can also run `php --ini` inside terminal to see which files are used by PHP in CLI mode.
Fixed by adding the following to .platform.app.yaml
runtime:
extensions:
- mcrypt
After installing Platform CLI the user cannot login using the Linux GUI login screen. The X-server crash and return to the login screen.
Switching to a different tty and running startx works as a workaround.
Commenting the .profile lines that are added by the installation script allows the user to login on the Linux GUI again.
Linux distribution: Linux Mint Debian Edition
zsh is also installed, but I'm not sure if this is relevant to the issue.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.