Appearance
Publishing a site
A site turns a page, and pages you choose beneath it, into a website. The site is served as plain HTML at /sites/<address>/ on the Notesflow server. It can be open to anybody, to anybody signed in, or only to the people you name.
The design rule behind it: a page is never published because of where it is filed. Every page is chosen by a person, and every publish sends exactly the list that person reviewed. The repository's docs/adr/0013-publishing-sites.md records why.
Starting a site
Open the page that should be the home page and press Publish in its header, or choose Publish this page as a site… in the palette. Give the site a title and an address, choose who may read it, and press Create draft site.
A new site is a draft. Only the people who manage it can see it, and they see it with a banner saying so. Nothing under the home page is chosen yet.
Publishing needs the Publish sites permission (publish_sites). Admins have it. For anybody else, an admin gives it to a custom role, or names them a manager of one site.
The sitemap
The sitemap lists every page under the home page, in the order of the page tree, and every page anybody has decided about. Each page shows one of these states:
| State | Means |
|---|---|
| Published | On the site now, and staying. |
| Will be published | Chosen, and added at the next publish. |
| Will be taken off | On the site now, left off since. Removed at the next publish. |
| Left off | Somebody decided it stays off. |
| New — not reviewed | Nobody has decided about it. It is not published. |
| Not served | Chosen, but in the trash, archived or moved out of the site. It stays off until it is back. |
Tick or untick pages, or use Choose all new or Leave all new off, then Save. Saving changes nothing for readers.
A page written later under a published section appears here as new. It is not on the site until somebody chooses it and publishes. The site's entry in the console shows how many pages are waiting for review.
A page you cannot open appears as A page you cannot open. You can leave it off, but you cannot choose it or publish it.
Publishing
Press Review and publish…. You see the exact list of pages that will be served and who will be able to read them. Publish sends that list. If anything changed since you looked, such as a page chosen by somebody else, a page moved in or a page trashed, the publish is refused and the sitemap reloads for you to look again.
Preview the next publish opens the site as it will be after you publish. Only people who manage the site can see the preview.
After publishing:
- Edits are live. Changing the words on a published page changes the site at once. Only which pages are on the site waits for a publish.
- Trashing, archiving or moving a page out takes it off the site immediately.
- A published page shows a Published badge in its header, so everybody writing it knows it is public.
- Unpublish takes the whole site down and keeps your choices for the next publish.
Who may read it
| Audience | Readers |
|---|---|
| Only people on the list | The default. Named addresses, groups, or everyone in this workspace. |
| Anybody signed in | Any account on this Notesflow, in any workspace. |
| Anybody with the link | No sign-in. Search engines may list it; it has a sitemap.xml. |
Everybody on the list has a role:
- Viewer: may read the site when it is restricted to the list.
- Manager: may also change the site and publish it, without holding Publish sites for the whole workspace. A manager can only choose pages they can open, and cannot delete the site.
A list entry can be an email address of somebody who has never signed in. It applies as soon as they do.
Making a site that is already live open to anybody takes effect when you save it. You are asked to type the site's address first.
A reader who has to sign in is sent to the sign-in page, and brought back to the page they asked for afterwards.
Searching a site
Every page of a site has a search box. It finds words on the site's own pages and nowhere else, so a page you left off cannot be found by searching either. A preview's search covers the pages the next publish would show.
A site's own address
Your administrator can give sites a domain of their own. Each site then lives at its own address, such as handbook.sites.example.com, made from the address you choose for the site. The dialog shows it that way. Links to the old /sites/handbook/ form keep working and lead there.
Signing in to a site on its own address takes one extra hop that you won't need to do anything for. If you are already signed in to Notesflow, you are signed in to the site straight away; otherwise you sign in once and land on the page you asked for. Signing out of Notesflow signs you out of every site.
Changing a site's address
You can change a site's address under Address and audience. The old address keeps working for a published site: it leads to the new one, so links people already shared still arrive. A site's old addresses, including those of a deleted site, are never given to another workspace. Your own workspace can reuse them.
With sign-in turned off
If the deployment does not require sign-in, every site can be read by whoever can reach the server, including drafts, just as the workspace itself can be. The publish dialog says so.
What a published page shows
The page's title and its writing: text, headings, lists, to-dos, quotes, callouts, code, tables, images, attachments, database views and block references.
Some things are never shown on a site:
- Page properties, comments, authors and history.
- Links to pages that are not on the site. The link's words stay; the link goes.
- Rows of a database view whose pages are not on the site.
- Passages quoted by a block reference from a page not on the site. The reference says so instead.
- Script, of any kind. So a diagram shows the source it is drawn from. Mathematics is still drawn, by the browser itself (MathML), with the TeX folded beneath it.