lando / docs

The main docs site for Lando
https://docs.lando.dev/
GNU General Public License v3.0
20 stars 56 forks source link

Lando Engine API Documentation confusion #11

Closed Xilonz closed 2 years ago

Xilonz commented 3 years ago

While working on a custom tooling command I found out that the Lando engine API documentation is (completely?) wrong or confusing.

https://docs.lando.dev/api/engine.html#lando-engine-run-data-%E2%87%92-promise

Insead of:

return lando.engine.run({
  id: 'myapp_database_1',
  cmd: ['bash'],
  opts: {
    mode: 'attach'
  }
});

Something like this is required I think, this is what, for example, the ssh task looks to be doing something similar like this:

const app = lando.getApp(root, false);
return lando.engine.run({
  compose: app.compose,
  project: app.project,
  cmd: [ 'bash'],
  opts: {
    mode: 'attach',
    services: ['appserver'],
   }
});
stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions and please check out this if you are wondering why we auto close issues.

reynoldsalec commented 2 years ago

The API docs were removed because they're out-of-date; they need to be revisited for Lando 4.x.

For now, I made a commit to remove the API link in the footer (one of the last remaining API links) to prevent future confusion.