Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generate hotkeys section/doc using script and check with CI #126

Closed
amanagr opened this issue Jul 12, 2018 · 5 comments
Closed

Generate hotkeys section/doc using script and check with CI #126

amanagr opened this issue Jul 12, 2018 · 5 comments
Labels
area: documentation Requires changes in documentation area: hotkeys area: infrastructure Project infrastructure good first issue Good for newcomers help wanted This issue should be clear enough to work on high priority should be done as soon as possible PR needs review PR requires feedback to proceed
Milestone
0.7.0

Comments

@amanagr
Copy link
Member

amanagr commented Jul 12, 2018

All the keybindings used by zulip-terminal are stored in zulipterminal/config.py. We can generate README section of the hotkeys by travic CI.

We can create a different section for hotkeys that are imported from urwid and urwid_readline libraries.
@amanagr amanagr added help wanted This issue should be clear enough to work on good first issue Good for newcomers area: hotkeys labels Jul 12, 2018
@punchagan
Copy link
Member

There should be a tool that developers can run locally, to generate this section of the README. TravisCI should only check that any commit doesn't miss out on doing that, when keyconfig has changed in anyway. Some sort of a test can be run that compares the output of README when this script is run, and the README committed to the repo.

@neiljp
Copy link
Collaborator

neiljp commented Nov 16, 2018

I just thought this myself when opening #165 for some recent changes, and #164 for starred messages :)

@amanagr amanagr added the high priority should be done as soon as possible label Dec 16, 2018
@amanagr amanagr mentioned this issue Jan 16, 2019
Merged
@neiljp
Copy link
Collaborator

neiljp commented Jan 26, 2021

I believe we've discussed moving the hotkeys from README into docs/, so that might be a good first step, updating all the links, followed by the automatic synchronization via a script and then checking that with a GitHub Action (since we don't use Travis now).

@neiljp neiljp changed the title Generate README hotkeys section using Travic CI. Generate hotkeys section/doc using script and check with CI Jan 26, 2021
@neiljp
Copy link
Collaborator

neiljp commented Jan 26, 2021

This is a similar issue to #892.

@neiljp neiljp added area: documentation Requires changes in documentation area: infrastructure Project infrastructure labels Jan 26, 2021
@neiljp neiljp added this to the Release after next milestone Jan 28, 2021
mkp6781 added a commit to mkp6781/zulip-terminal that referenced this issue Feb 17, 2021
@mkp6781
tools: Automate generation of Hot Key section.
8bbd1f1 
Generates markdown file hotkeys.md using `KEY_BINDINGS` and
`HELP_CATEGORIES` from `keys.py`. This ensures that changes to
command keys are reflected automatically in the documentation
when the user runs the `generate_hotkey.py` script.

Fixes zulip#126.
mkp6781 added a commit to mkp6781/zulip-terminal that referenced this issue Feb 17, 2021
@mkp6781
tools: Automate generation of Hot Key section.
4e46979 
Generates markdown file hotkeys.md using `KEY_BINDINGS` and
`HELP_CATEGORIES` from `keys.py`. This ensures that changes to
command keys are reflected automatically in the documentation
when the user runs the `generate_hotkey.py` script.

Fixes zulip#126.
mkp6781 added a commit to mkp6781/zulip-terminal that referenced this issue Feb 17, 2021
@mkp6781
tools: Automate generation of Hot Key section.
894f69c 
Generates markdown file hotkeys.md using `KEY_BINDINGS` and
`HELP_CATEGORIES` from `keys.py`. This ensures that changes to
command keys are reflected automatically in the documentation
when the user runs the `generate_hotkey.py` script.

Fixes zulip#126.
mkp6781 added a commit to mkp6781/zulip-terminal that referenced this issue Feb 17, 2021
@mkp6781
tools: Automate generation of Hot Key section.
e6722aa 
Generates markdown file hotkeys.md using `KEY_BINDINGS` and
`HELP_CATEGORIES` from `keys.py`. This ensures that changes to
command keys are reflected automatically in the documentation
when the user runs the `generate_hotkey.py` script.

Fixes zulip#126.
@mkp6781
Copy link
Contributor

mkp6781 commented Feb 17, 2021 •
edited
Loading

@zulipbot remove "PR needs review"

@zulipbot zulipbot added the PR needs review PR requires feedback to proceed label Feb 17, 2021
@mkp6781 mkp6781 mentioned this issue Feb 17, 2021
Closed
mkp6781 added a commit to mkp6781/zulip-terminal that referenced this issue Feb 18, 2021
@mkp6781
tools: Automate generation of Hot Key section.
eb072a3 
Generates markdown file hotkeys.md using `KEY_BINDINGS` and
`HELP_CATEGORIES` from `keys.py`. This ensures that changes to
command keys are reflected automatically in the documentation
when the user runs the `generate_hotkey.py` script.

Fixes zulip#126.
mkp6781 added a commit to mkp6781/zulip-terminal that referenced this issue Feb 18, 2021
@mkp6781
tools: Automate generation of Hot Key section.
5901013 
Generates markdown file hotkeys.md using `KEY_BINDINGS` and
`HELP_CATEGORIES` from `keys.py`. This ensures that changes to
command keys are reflected automatically in the documentation
when the user runs the `generate_hotkey.py` script.

Fixes zulip#126.
mkp6781 added a commit to mkp6781/zulip-terminal that referenced this issue Feb 23, 2021
@mkp6781
tools: Automate generation of Hot Key section.
79de909 
Generates markdown file hotkeys.md using `KEY_BINDINGS` and
`HELP_CATEGORIES` from `keys.py`. This ensures that changes to
command keys are reflected automatically in the documentation
when the user runs the `generate_hotkey.py` script.

Fixes zulip#126.
mkp6781 added a commit to mkp6781/zulip-terminal that referenced this issue Feb 23, 2021
@mkp6781
tools: Automate generation of Hot Key section.
0c8ed4b 
Generates markdown file hotkeys.md using `KEY_BINDINGS` and
`HELP_CATEGORIES` from `keys.py`. This ensures that changes to
command keys are reflected automatically in the documentation
when the user runs the `generate_hotkey.py` script.

Fixes zulip#126.
mkp6781 added a commit to mkp6781/zulip-terminal that referenced this issue Feb 25, 2021
@mkp6781
tools: Automate generation of Hot Keys section.
040f97c 
Generates markdown file hotkeys.md using `KEY_BINDINGS` and
`HELP_CATEGORIES` from `keys.py`. This ensures that changes to
command keys are reflected automatically in the documentation
when the user runs the `generate_hotkey.py` script.

Fixes zulip#126.
mkp6781 added a commit to mkp6781/zulip-terminal that referenced this issue Feb 26, 2021
@mkp6781
tools: Automate generation of Hot Keys section.
17394b9 
Generates markdown file hotkeys.md using `KEY_BINDINGS` and
`HELP_CATEGORIES` from `keys.py`. This ensures that changes to
command keys are reflected automatically in the documentation
when the user runs the `generate_hotkeys.py` script.

Fixes zulip#126.
mkp6781 added a commit to mkp6781/zulip-terminal that referenced this issue Mar 1, 2021
@mkp6781
tools: Automate generation of Hot Keys section.
b55adac 
Generates markdown file hotkeys.md using `KEY_BINDINGS` and
`HELP_CATEGORIES` from `keys.py`. This ensures that changes to
command keys are reflected automatically in the documentation
when the user runs the `generate_hotkeys.py` script.

Fixes zulip#126.
@neiljp neiljp closed this as completed in a4aa5db Mar 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: documentation Requires changes in documentation area: hotkeys area: infrastructure Project infrastructure good first issue Good for newcomers help wanted This issue should be clear enough to work on high priority should be done as soon as possible PR needs review PR requires feedback to proceed
Projects
None yet
Milestone
0.7.0
Development

Successfully merging a pull request may close this issue.

Generate hotkey using script mkp6781/zulip-terminal
5 participants
@punchagan @neiljp @amanagr @zulipbot @mkp6781