Commit Graph

257 Commits

Author SHA1 Message Date
Stefan Sedich
59a9c03267 Add common plugin dependencies to getting started docs (#510)
* Add extra plugin dependencies

I found on a fresh Ubuntu install test that it pays to have unzip and curl installed for some of the asdf plugins to install properly so it seems to make sense adding these here to give a nicer getting started experience.

I do not have brew or spack handy to test but from what I can see these packages should exist.

* Update core-manage-asdf-vm.md
2019-04-10 09:15:15 +10:00
Daniel Perez
611fafbadc Update version to 0.7.1 2019-03-31 21:15:17 +01:00
Carsten Dreesbach
e9bc12c80c Fix verison typo 2019-03-26 08:36:50 -04:00
James Hegedus
510bcdb118
note legacy version files in core setup guide (#500)
as suggested in https://github.com/asdf-vm/asdf/issues/499
2019-03-26 10:31:08 +11:00
Trevor Brown
bc1d9cb2c2
Merge pull request #497 from asdf-vm/rc-releases
Add support for RC releases
2019-03-25 08:19:30 -04:00
Trevor Brown
85057b6969 Add support for RC versions to asdf update command 2019-03-24 18:24:19 -04:00
Damian Bouné
19167aafce Add Homebrew instructions for install and bash (#496) 2019-03-25 09:12:23 +11:00
Daniel Perez
5a89e48045
Merge pull request #495 from asdf-vm/fix-edit-on-github
Use custom edit on github plugin. Fix #469
2019-03-24 19:26:22 +00:00
Daniel Perez
2d29d9534c Use custom edit on github plugin. Fix #469 2019-03-24 14:30:53 +00:00
James Hegedus
96e010396a
rename docs/hompage to docs/README to use default Docsify settings (#492)
rename docs/homepage.md to docs/README.md as the Docsify default of loading README.md works in a multi-lang setup whereas defining a custom homepage does not at this time.
2019-03-22 17:37:37 +11:00
James Hegedus
68ff07e09d
fix quote typo in docs homepage (#490)
# Summary

The homepage wasn't importing the required `.md` files appropriately due to the Docsify embed feature requiring single quotes, not double quotes.

## Other Information

We should update the information about Prettier use to specify that these pages require single quotes.
2019-03-22 17:27:07 +11:00
Daniel Perez
f372833226 Add documentation about multiple versions 2019-03-16 19:45:38 +00:00
Trevor Brown
9e30218766 Update version to 0.7.0 2019-03-02 09:45:43 -05:00
Isaac Whitfield
cf6149f622 document Spack to install plugin deps (#471) 2019-02-22 08:25:40 +11:00
Trevor Brown
62cd0561e2 Create CNAME 2019-02-12 09:12:13 -05:00
James Hegedus
abea57501d
add "versions" to docs subtitle (#462)
as with #460
2019-02-11 17:39:15 +11:00
Trevor Brown
b1d8ead5a0 Delete CNAME 2019-02-05 08:54:48 -05:00
Trevor Brown
4739b38c2e Create CNAME 2019-02-05 08:54:22 -05:00
Davor Badrov
d9e2d567f8 [docs] add commands for macOS and Fedora plugins dependencies (#454) 2019-02-02 20:56:49 +11:00
James Hegedus
f19d5a25ee
add list of improvements to docs (#448) 2019-02-01 22:59:11 +11:00
James Hegedus
65aa5abe4e
de-dupe readme and finalise docs site (#441)
* save old readme for migration purposes

* promote new readme

* use the repo readme from the doc site homepage

* mention extendable plugin system in title and old plugin support

* improve subtitles english

* update links to direct users to the site!

* add link to docs site in readme until github repo site link is populated

* update troublesome contributing section
2019-01-29 22:31:34 +11:00
James Hegedus
57c5e9dbcb
Significant documentation site improvements (#440)
# Summary

This contains fixes and significant improvements to the documentation site.

* fixes some routing issues due to erroneous docsify config
* fixed links and layout of 404 pg
* improved the language on the landing page as per #438 
* propose a NEW_README.md tackling concerns with #438  and #422 
* use docsify specific md to emphasise some text
* add docsify-themeable plugin to improve loading experience and future proof for customisation
* improve use of `asdf-vm` over `asdf`

## Other Information

Included in this PR is a file `docs/NEW_README.md` which is my proposed README for this repo. The intention was to have all documentation in a single place, the site, and simplify the readme bringing the focus to explaining the tool rather than instructing users on how to use it.

I will create a separate PR for the README, but in the meantime the landing page composes this new readme with the ballad.
2019-01-25 19:17:20 +11:00
Jean-Denis Vauguet
bfb28b76b7
Update core-manage-asdf-vm.md 2019-01-24 00:58:45 +01:00
John Doe
59c1cc0b37 Commit all files changed by release.sh before it tags 2019-01-19 09:29:55 -05:00
jthegedus
aeab589fbd improve prose of uninstall instructions 2019-01-16 07:42:14 +11:00
James Hegedus
2fcde332ae Documentation site (#422)
* init docsify
* add config & plugins to support required features
* create cover page
* add sidebar headings
* add novel 404 page
* add translation message to 404
* add navbar with translations dropdown
* fix punctuation
* add all-plugins section pulling from asdf-plugins repo readme
* update sidebar with sections, better names & descriptions for contributors
* add changelog. pulls from repo
* add thanks page. credits, maintainers & link to contributors on github
* add core documentation
* rm old readme from docs/ folder
this was copied here on docsify init
* comment out some translation config
  ideally this will remain commented out serving as an example for any translation contributions
* run prettier over markdown
* add plugins-create section
* add contributing sections to the docs
* fix cover page get-started link
* use the readme as the main homepage
* update asdf version in docs with release script
2019-01-12 11:32:30 -05:00
Marcos Ferreira
5a2e69ca86
Add info about using the CI repo on plugin test 2018-10-24 19:20:13 -03:00
Trevor Brown
201449eca6 Add info on new --asdf-tool-version flag. 2018-10-20 10:56:20 -04:00
Victor Hugo Borja
a4fc43e682 plugin-test: check Auth is used when list-all uses Github API
Many plugins were having this problem where they rely on accessing
GitHub's API for listing versions from some repo releases. But not
setting an Authorization token for `curl`, causes the test to fail.

We now detect that if the plugin `list-all` looks like accessing
`api.github.com` and if so, we also try to guess if the Authroization
header will be set. If not, we fail the test and head the plugin author
to some documentation on how to add it.

Hope this reduces the number of failures due to GitHub API rate
limiting on travis.
2018-08-29 23:19:30 -07:00
Andrew Thauer
d94e0223bf Implement plugin hook to customize executable path
This feature allows the plugin to optionally change the executable path
of a shim prior to execution. This is useful when the plugin tool has
commands that may exist in multiple locations (like npm).
2018-04-25 22:18:34 -04:00
Trevor Brown
8946fbd3c3 Add documentation on uninstalling asdf. 2017-10-23 11:06:48 +03:00
Trevor Brown
957c6307c6 Add details on ASDF_CONCURRENCY to the plugin guide. 2017-08-20 19:20:39 -04:00
Trevor Brown
286295bec4 Add more details on the proper behavior of install scripts to the plugin guide. 2017-08-17 14:14:14 -04:00
Daniel Perez
78fbbaf584 Merge pull request #183 from doughsay/master
Use a git repository for installing plugins.
2017-07-26 18:49:15 +02:00
Chris Dosé
1bdaf22a36
Update README and creating-pugins doc to reflect new plugin-add command. 2017-07-25 17:15:08 -07:00
Robin Schneider
7c30e6f9d2
Fix typo: seperated → separated
Automated edit command: git ls-files -z "$(git rev-parse --show-toplevel)" | xargs --null -I '{}' find '{}' -type f -print0 | xargs --null sed --in-place --regexp-extended 's/seperated/separated/g;'
2017-02-20 19:44:44 +01:00
Stratus3D
4a4d9022f0 Add note on the recommended way to manually sort versions. 2016-12-14 11:04:31 -05:00
Victor Borja
da6b907b1d Add documentation on metadata for shim authors 2016-12-14 11:01:17 -05:00
Trevor Brown
7210d09938 Add a couple lines to the creating-plugins guide on version ordering. 2016-12-13 22:33:23 -05:00
Kevin Rockwood
20739721ca Add note about parse-legacy-file argument 2016-08-30 09:25:52 +09:00
Kevin Rockwood
333339b960 Update plugin docs with new legacy file api 2016-08-14 09:10:24 +09:00
Daniel Perez
caee08d39b Improve plugin tests 2016-06-17 18:37:26 +09:00
Daniel Perez
072a57e4cb Add command and instructions to test plugin. 2016-05-13 16:04:01 +09:00
Trevor Brown
30173d4dcf Add details on get_version_from_legacy_file script to creating-plugins.md document. 2015-11-27 11:17:46 -05:00
Akash Manohar J
9348661916 Documentation about custom shim 2015-06-07 00:37:57 +05:30
Akash Manohar J
a049ac1c2e New plugin API 2015-05-22 10:41:37 +05:30
Akash Manohar
2594321556 Rename docs/ballad-of-asdf.md to ballad-of-asdf.md 2015-05-22 06:59:27 +05:30
Akash Manohar J
0e1627fe20 Merge branch 'master' of github.com:HashNuke/asdf 2015-05-18 06:58:16 +05:30
Akash Manohar
737c6cc384 Update creating-plugins.md 2015-05-18 06:57:38 +05:30
Akash Manohar J
a1d43f524d Merge branch 'master' of github.com:HashNuke/asdf 2015-05-18 06:55:46 +05:30
Akash Manohar J
978ba18727 Move ballad to docs 2015-05-18 06:51:53 +05:30
Akash Manohar J
d3da8b0ea3 Move doc 2015-05-17 23:54:32 +05:30
Akash Manohar J
ec29a48342 Cleanup docs a bit 2015-05-17 23:20:08 +05:30
Akash Manohar J
042cf64c59 Updates to docs 2015-05-17 23:12:05 +05:30
Akash Manohar J
fcee88dadb Smaller font 2015-03-03 21:32:48 +05:30
Akash Manohar J
8482243bdf Remove line about custom args 2015-03-03 12:25:49 +05:30
Akash Manohar J
228d337849 Shorten readme 2014-12-20 19:35:56 +05:30