Permalink
Browse files

[docs] Update documentation in preparation for release

  • Loading branch information...
anjakefala committed Dec 21, 2017
1 parent 48e9f42 commit 42239f974b95456ca8f231926e64b35d4f56c6e9
Showing with 38 additions and 21 deletions.
  1. +2 −2 CONTRIBUTING.md
  2. +4 −4 README.md
  3. +15 −13 RELEASE.md
  4. +7 −0 visidata/man/vd.1
  5. +7 −0 visidata/man/vd.inc
  6. +2 −2 www/help/index.md
  7. +1 −0 www/template.html
View
@@ -17,11 +17,11 @@ In addition, the innermost core file, `vdtui.py`, is a single-file stand-alone l
### Feature requests or enhancements
If you use VisiData, I would love it if you reached out to me to discuss some of your common workflows and needs. This helps me better prioritize which functionality to add. Send me a [screencast](http://asciinema.org), or some sample data along with your desired output. There is probably a way to tweak VisiData to get the job done even more to your liking. Feature requests should be made on any of the communication channels listed [here](https://github.com/saulpw/visidata/blob/develop/CONTRIBUTING.md#community).
If you use VisiData, I would love it if you reached out to me to discuss some of your common workflows and needs. This helps me better prioritize which functionality to add. Send me a [screencast](http://asciinema.org), or some sample data along with your desired output. There is probably a way to tweak VisiData to get the job done even more to your liking. Feature requests should be made on any of the communication channels listed [here](https://github.com/saulpw/visidata/blob/stable/CONTRIBUTING.md#community).
### Filing issues or support
Create a GitHub issue if anything doesn't appear to be working right. If you get an unexpected error, please include the full stack trace that you get with `Ctrl-E`. Additionally, it would help me more quickly diagnose the problem if you could attach the saved Commandlog (`Ctrl-D`), which will show the steps that lead to the issue. If you are struggling with learning how to use the tool, or are unsure how something works, please also file an issue or write a comment in any of our [community spaces](https://github.com/saulpw/visidata/blob/develop/CONTRIBUTING.md#community). In addition to wanting to help users get the most out of the tool, this helps us gauge the holes in our documentation.
Create a GitHub issue if anything doesn't appear to be working right. If you get an unexpected error, please include the full stack trace that you get with `Ctrl-E`. Additionally, it would help me more quickly diagnose the problem if you could attach the saved Commandlog (`Ctrl-D`), which will show the steps that lead to the issue. If you are struggling with learning how to use the tool, or are unsure how something works, please also file an issue or write a comment in any of our [community spaces](https://github.com/saulpw/visidata/blob/stable/CONTRIBUTING.md#community). In addition to wanting to help users get the most out of the tool, this helps us gauge the holes in our documentation.
### Contributing tests
View
@@ -13,9 +13,9 @@ A terminal interface for exploring and arranging tabular data.
## Installation
There are three options for installing visidata:
- [pip3](https://github.com/saulpw/visidata/tree/develop#install-via-pip3) for users who wish to import visidata into their own code or wish to integrate it into a python virtual environment
- [Homebrew](https://github.com/saulpw/visidata/tree/develop#install-via-brew) on MacOS/X for reliable installation of application components (such as the manpage)
- [apt](https://github.com/saulpw/visidata/tree/develop#install-via-apt) on Linux distributions
- [pip3](https://github.com/saulpw/visidata/tree/stable#install-via-pip3) for users who wish to import visidata into their own code or wish to integrate it into a python virtual environment
- [Homebrew](https://github.com/saulpw/visidata/tree/stable#install-via-brew) on MacOS/X for reliable installation of application components (such as the manpage)
- [apt](https://github.com/saulpw/visidata/tree/stable#install-via-apt) on Linux distributions
### Install via pip3
@@ -79,7 +79,7 @@ $ vd [<options>] <input> ...
$ <command> | vd [<options>]
```
VisiData supports tsv, csv, xlsx, hdf5, sqlite, and more.
VisiData supports tsv, csv, xlsx, hdf5, sqlite, json and more.
Use `-f <filetype>` to force a particular filetype.
## Documentation
View
@@ -6,17 +6,19 @@
3. Verify that documentation/docstrings are up-to-date on features and functionality
4. Set version number to next most reasonable number (v#.#.#)
4. Verify that setup.py is up-to-date with requirements.
5. Set version number to next most reasonable number (v#.#.#)
a. add to front of CHANGELOG, along with the release date and bullet points of major changes
b. update version number on README and front page of website
c. bump version in `__version__` in source code (bin/vd, visidata/vdtui.py) and setup.py
5. Run ./mkwww.sh to build the manpage and updated website
6. Run ./mkwww.sh to build the manpage and updated website
6. Push `develop` to testpypi
7. Push `develop` to testpypi
a. set up a ~/.pypirc
@@ -43,7 +45,7 @@
twine upload dist/* -r testpypi
```
7. Test install from testpypi
8. Test install from testpypi
a. on virgin instance
@@ -57,37 +59,37 @@
pip3 install --extra-index-url https://test.pypi.org/project visidata
```
10. Merge `develop` to stable
9. Merge `develop` to stable
11. Merge `stable` back into other branches
10. Merge `stable` back into other branches
a. if the branch works with minimal conflicts, keep the branch
b. otherwise, clean out the branch
12. Push stable to pypi
11. Push stable to pypi
```
twine upload dist/*
```
13. Test install/upgrade from pypi
12. Test install/upgrade from pypi
a. build and check readthedocs/stable
b. Ask someone else to test install
14. Create a tag `v#.#.#` for that commit
13. Create a tag `v#.#.#` for that commit
```
git tag v#.#.#
git push --tags
```
15. Push code to stable
14. Push code to stable
16. Write up the release notes and post at visidata.org/release/#.#
15. Write up the release notes and post at visidata.org/release/#.#
17. Comb through issues and close the ones that have been solved, referencing the version number
16. Comb through issues and close the ones that have been solved, referencing the version number
18. Post release notes on r/visidata and tinyletter and have some ice cream
17. Post release notes on r/visidata and tinyletter and have some ice cream
View
@@ -794,6 +794,13 @@ These are the supported sources:
.El
.El
.Pp
.Bl -inset -compact -offset xxx
.It Sy json No (javascript object notation)
.Bl -inset -compact -offset xxx
.It Nested components of .json files are represented as cells containing lists ( Ns Sy [] Ns ). They can be further expanded with Sy z^Y.
.El
.El
.Pp
.Bl -inset -compact
.It For these multi-table sources, the first sheet is a directory of tables.
.It Sy Enter No loads the entire table into memory.
View
@@ -640,6 +640,13 @@ These are the supported sources:
.El
.El
.Pp
.Bl -inset -compact -offset xxx
.It Sy json No (javascript object notation)
.Bl -inset -compact -offset xxx
.It Nested components of .json files are represented as cells containing lists ( Ns Sy [] Ns ). They can be further expanded with Sy z^Y.
.El
.El
.Pp
.Bl -inset -compact
.It For these multi-table sources, the first sheet is a directory of tables.
.It Sy Enter No loads the entire table into memory.
View
@@ -10,9 +10,9 @@ There are three options for installing visidata:
*Where can I learn how to use VisiData?*
We have documentation in various levels of detail available at [visidata.org/docs](http://visidata.org/docs/) from [an overview of all commands](http://visidata.org/man/) to [workflow recipes](http://visidata.org/howto).
We have documentation in various levels of detail available at [visidata.org/docs](http://visidata.org/docs/) from [an overview of all commands](http://visidata.org/man/) to [workflow recipes](http://visidata.org/test).
If you have a workflow which you do not see covered, please don't hestitate to [file an issue](https://github.com/saulpw/visidata/issues/new) or post a comment in any of our [community spaces](https://github.com/saulpw/visidata/blob/develop/CONTRIBUTING.md#community). Our documentation is an ongoing effort, and we wish to prioritise the writing of recipes around user needs.
If you have a workflow which you do not see covered, please don't hestitate to [file an issue](https://github.com/saulpw/visidata/issues/new) or post a comment in any of our [community spaces](https://github.com/saulpw/visidata/blob/stable/CONTRIBUTING.md#community). Our documentation is an ongoing effort, and we wish to prioritise the writing of recipes around user needs.
*I found a bug!*
View
@@ -27,6 +27,7 @@
<h2>home</h2>
</a>
<h2><a href="/about">about</a></h2>
<h2><a href="/install">install</a></h2>
<h2><a href="/docs">documentation</a></h2>
<h2><a href="/help">support</a></h2>
<h2><a href="/news">release history</a></h2>

0 comments on commit 42239f9

Please sign in to comment.