writefreely / documentation Goto Github PK

Please specify what license this documentation is subject to.

Without a license, we cannot ship the writefreely documentation with a writefreely binary package.

Reading this blog post made me think the developer/setup.md guide should include steps for installing everything without using make. Thoughts?

As reported by @wakest in this fedi thread, we should add information about hashtags in posts -- including how they are federated.

Describe the bug

following the guide to https://writefreely.org/docs/latest/developer/setup step to build from source and failed.

Steps to reproduce (if necessary)

run "go get -d github.com/writeas/writefreely/cmd/writefreely"
and it occurs:

➜  /usr/local/go/src go get -d github.com/writeas/writefreely/cmd/writefreely

go: downloading github.com/writeas/writefreely v0.13.1
go: found github.com/writeas/writefreely/cmd/writefreely in github.com/writeas/writefreely v0.13.1
go get: github.com/writeas/[email protected]: parsing go.mod:
	module declares its path as: github.com/writefreely/writefreely
	        but was required as: github.com/writeas/writefreely

Expected behavior

Application configuration

I build this on silicon arm64 macos.
go version:

➜  /usr/local/go/src go version
go version go1.15.6 darwin/amd64

Currently, and according to issue #80 on the writefreely repo, in the future, the post rendering function does not allow data URI images (by default).

That behavior isn't "standard," as much as I see a standard applying, and so it should be documented along with the rest of information about post/link rendering.

Greetings!

Writefreely has recently had a 0.13.2 release. Will this project get such a release, too?

We can do this either in the install guide or another admin guide.

Carried over from the suggestion in writefreely/writefreely#629.

Describe the bug

The --create-admin option is not shown/documented in writefreely

Steps to reproduce (if necessary)

Steps to reproduce the behavior:

1. type writefreely user -h
2. note that --create-admin is not listed

Expected behavior

--create-admin should be listed

Application configuration

• Single mode or Multi-user mode? Multi
• Database? sqlite
• Open registration? no
• Federation enabled? yes

Version or last commit: 0.13.2

We don't currently have any documentation for setting up OAuth providers: Write.as, Slack, GitLab.

Copy over the Show an Excerpt post from the How to Use Write.as blog.

Issue was brought up on the forum.

The documentation is supposed to be hosted at https://writefreely.org/docs . Numerous links from writefreely.org and GitHub point to this URL.

The target site currently reads

Umm... This page doesn't exist :)

• They can be shared by ID on (instance config value) private = false instances
• Draft URLs are unguessable, essentially making them private
• Hashtags won't render

On a fresh install, pages have a footer with a Writer's Guide that links to https://writefreely.org/guide/v0.13.2

This, unfortunately, 404's.

Further, when looking to edit the footer includes, it appears in the release tarball someone's temporary edit lockfiles are present?

-rw-r--r-- matt/matt 12288 2022-11-10 23:51 writefreely/templates/include/.footer.tmpl.swp
-rw-r--r-- matt/matt 20480 2022-11-10 23:51 writefreely/templates/user/.admin.tmpl.swp

It looks like someone needs to decide whether the website should handle the versioned writer's guides appropriately or rip out the {{.OfficialVersion}} part of the URI to something a little more static in the templates?

The developer quick start would be great, but...

go get -d github.com/writefreely/writefreely/cmd/writefreely go: go.mod file not found in current directory or any parent directory. 'go get' is no longer supported outside a module. To build and install a command, use 'go install' with a version, like 'go install example.com/cmd@latest' For more information, see https://golang.org/doc/go-get-install-deprecation or run 'go help get' or 'go help install'.
go version go1.19.2 linux/amd64

Even if the first step was to work, what is $GOPATH expected to be?

`write@ded1 ~ $ echo $GOPATH

write@ded1 ~ $`

Even in the detail steps:

`go get -u github.com/jteeuwen/go-bindata/go-bindata
go-bindata -pkg writefreely -ignore=\.gitignore schema.sql sqlite.sql

The first step doesn't seem to put go-bindata in an expected path... were you expecting a system-wide install?

If I use a system-wide go-bindata, then things seem OK until this section:

cd less
export CSSDIR=../static/css/
lessc app.less --clean-css="--s1 --advanced" $(CSSDIR)write.css
lessc fonts.less --clean-css="--s1 --advanced" $(CSSDIR)fonts.css
lessc icons.less --clean-css="--s1 --advanced" $(CSSDIR)icons.css`

../node_modules/less/bin/lessc app.less --clean-css="--s1 --advanced" $(CSSDIR)write.css -bash: CSSDIR: command not found Unable to load plugin clean-css please make sure that it is installed under or at the same level as less

Sorry, what shell are we using? ${CSSDIR} is what bash needs, no?

But...
../node_modules/less/bin/lessc app.less --clean-css="--s1 --advanced" ${CSSDIR}write.css Unable to load plugin clean-css please make sure that it is installed under or at the same level as less

Stuck here, since lessc installed via the recommended npm command seems to be missing stuff.

Both paths seem to fail in a bash user-level setup.

As mentioned in writefreely/writefreely#469, we need to document these attributes for setting up a generic OAuth provider.

Describe the bug

https://writefreely.org/docs/v0.13.2/writer/writing.md

Section Syntax-highlighted Code Blocks.

It doesn't. :-)

Looks like three-backticks-go isn't quite interpreted, or you forgot closing three-backticks?

Expected behavior

Probably rendering a syntax highlighten source code.

Describe the bug

The installation from souce guide is missing prosa elements

Steps to reproduce (if necessary)

Follow https://writefreely.org/docs/main/developer/setup, detailed steps
'Classics' editor is broken because prosa.css and prosa.bundle.js are not generated

Expected behavior

'Classics' editor working as normal

Application configuration

• Multi-user
• Database? [mysql]
• Open registration? [yes]
• Federation enabled? [yes]

Version or last commit: 0.15

From @wakest in writefreely/writefreely#257:

It took me a good 20 minutes of searching around to figure out where the RSS feeds to a WriteFreely blog were hidden because there is no mention of it in the Docs

There is also no mention of RSS feeds in the Account Settings / Customize Blog settings.

I eventually figured out that you can just append /feed to the url of a blog. It would be good to know what RSS features are implemented, if the feed has any options like limiting the feed to being only partial posts or full posts, how RSS feeds implement enclosures of embedded audio (can you make a podcast feed?)

We need to explain how to upgrade WriteFreely when using Docker.