Skip to content
Menu
OpenD Documentation
Version 0.1
Sign in

Edit docs in the browser

The web editor lets people who do not use Git change the docs. You save to your own working branch as often as you like, and publish through one pull request when you are ready.

How it works

  • The docs repository stays the only copy of the docs. The editor reads from it and writes to it through GitHub; it keeps no content of its own.
  • Save as often as you like. Each save is a commit to your own working branch. Nothing goes live and nobody is asked to review.
  • Publish when you are ready. The editor opens one pull request for everything you saved, and the repository's review rules on GitHub decide when it can merge.
  • Once it merges, the docs site builds and publishes it like any other push.
  • Commits name you as the author, even if you have no GitHub account, and the editor keeps a record of what you did. If you sign in with GitHub, they are commits by your own account, marked Verified by GitHub; see Verified commits.

Sign in

The editor has its own address, separate from the docs site. Your reader account does not open it, and signing in to the editor gives you nothing extra on the docs site.

  • Sign in with GitHub is for developers. If you can already push to the docs repository, you get in the first time you sign in.
  • Sign in with your company account is for everyone else. An administrator must add you first, by the email address your company account uses.

If the editor says you cannot edit these docs, or that you are not registered, ask whoever runs the editor to add you. Signing out ends your session at once.

The pages

Files
The topics and maps in the repository, with the ones you changed marked. Also where you create a topic and preview the docs as a customer org.
Publish
Your changes, what the repository needs before they can merge, and your pull request.
Activity
What you did in the editor: sign-ins, saves, merges from the main branch, conflict choices, publishes and previews, with their commits and pull requests.

The editor changes the DITA source of topics (.dita) and maps (.ditamap, .bookmap) in a text box. There is no visual editor yet. Images and other files are still changed in Git.

Next