Edit a doc page in a lightweight web-based editor

Bug #1003153 reported by Anne Gentle
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Core Infrastructure
Triaged
Wishlist
Unassigned

Bug Description

Offer a way for readers to edit a page in a lightweight web-based editor, then use git-review in the background to submit a review to Gerrit.

Monty said he had an idea about using git review in the background to help readers make quick edits to doc web pages.

David Cramer at Rackspace also found this annotation tool, wonder if there's a good mashup concept in there somewhere?
---
go to this page:

http://en.highscore.de/cpp/boost/containers.html#containers_array

Click the link "Found an error? Fix it in your browser"

Notice that you can now edit the page. If you click Save, two things
happen (I think):

1. Somehow your changes are saved (a cookie combined with something
saved on the server?) so you'll see them the next time you come back.

2. The page maintainer is notified and sent your edits. The maintainer
can then incorporate your changes into the source so it will be there
for the next build.

Note: the page is NOT updated for everyone.

The mark-keywords thing seems to be just a way for you to mark important
words and have them still be marked the next time you come back. Not
sure how useful that is.

---

Revision history for this message
Monty Taylor (mordred) wrote :

Once Clark is done with the new etherpad lite install, we'll be one step closer to this.

description: updated
summary: - Offer a way for readers to edit a page in a lightweight web-based
- editor, then use git-review in the background to submit a review to
- Gerrit.
+ Edit a doc page in a lightweight web-based editor
Changed in openstack-ci:
milestone: none → folsom
status: New → Triaged
importance: Undecided → Medium
Revision history for this message
James E. Blair (corvus) wrote :

How will this fulfill CLA requirements?

Revision history for this message
Anne Gentle (annegentle) wrote :

Here's my thinking about the workflow and who we expect to do this workflow:

http://wiki.openstack.org/Documentation/LightDocs

Basically I'd rather have already CLA-signed contributors be the primary focus.

Monty Taylor (mordred)
Changed in openstack-ci:
milestone: folsom → grizzly
Revision history for this message
James E. Blair (corvus) wrote :

The new etherpad is in place. Still wondering about CLA.

Changed in openstack-ci:
importance: Medium → Wishlist
James E. Blair (corvus)
Changed in openstack-ci:
milestone: grizzly → none
Khai Do (zaro0508)
tags: added: gerrit
Revision history for this message
Khai Do (zaro0508) wrote :

I believe an upcoming feature in Gerrit called Inline Edit will support this workflow. There is ongoing work upstream to make it a reality, https://gerrit-review.googlesource.com/#/q/topic:inline-3

Revision history for this message
Khai Do (zaro0508) wrote :

The inline edit feature has landed in master, expect it to be released in Gerrit ver 2.11. Currently it's not real usable because it doesn't come with a very nice editor, ongoing happening though.

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers