Docs Publisher issues
https://lab.civicrm.org/documentation/docs-publisher/-/issues
2017-10-19T15:15:20Z
https://lab.civicrm.org/documentation/docs-publisher/-/issues/81
Only publish a guide if the docs within its repo have been changed
2017-10-19T15:15:20Z
Sean Colsen
Only publish a guide if the docs within its repo have been changed
If an extension makes a code change (non-docs), the publisher will still re-publish the guide. When acting on webhook requests, we should look at either the webhook details or the git details to see if any docs files were changed and onl...
If an extension makes a code change (non-docs), the publisher will still re-publish the guide. When acting on webhook requests, we should look at either the webhook details or the git details to see if any docs files were changed and only publish if they were.
CC @Michael_McAndrew
https://lab.civicrm.org/documentation/docs-publisher/-/issues/80
Editing non-master branches with the pencil icon doesn't work
2017-10-19T15:10:25Z
Sean Colsen
Editing non-master branches with the pencil icon doesn't work
Steps to reproduce:
1. Go to the home page of the User Guide 4.6 edition
https://docs.civicrm.org/user/en/4.6/
1. Hover over the pencil icon at the top right of the page
1. Expect the URL to be
https://github.com/civicrm/civic...
Steps to reproduce:
1. Go to the home page of the User Guide 4.6 edition
https://docs.civicrm.org/user/en/4.6/
1. Hover over the pencil icon at the top right of the page
1. Expect the URL to be
https://github.com/civicrm/civicrm-user-guide/edit/4.6/docs/index.md
1. Observe the URL to be
https://github.com/civicrm/civicrm-user-guide/edit/master/docs/index.md
https://lab.civicrm.org/documentation/docs-publisher/-/issues/79
Allow multiple guides to be published from within one repository
2021-09-27T11:20:06Z
Sean Colsen
Allow multiple guides to be published from within one repository
In `books/*.yml`, allow a guide to define a subdirectory within the repo that should be used when publishing.
For example, in CiviCRM core, we *might* want to store the Dev Guide, User Guide, and Sysadmin Guide in separate folders with...
In `books/*.yml`, allow a guide to define a subdirectory within the repo that should be used when publishing.
For example, in CiviCRM core, we *might* want to store the Dev Guide, User Guide, and Sysadmin Guide in separate folders within the `docs` directory. This shouldn't be too hard if we just tell `mkdocs` to use a subfolder for its build process.
https://lab.civicrm.org/documentation/docs-publisher/-/issues/78
Allow books to define redirects which point to other books
2017-09-24T00:13:55Z
Sean Colsen
Allow books to define redirects which point to other books
Modify the internal redirect functionality to allow each book to define *external* redirects in the `redirects/internal.txt` file.
(I realize it won't be very intuitive to put external redirects in a file called `internal.txt`, but I th...
Modify the internal redirect functionality to allow each book to define *external* redirects in the `redirects/internal.txt` file.
(I realize it won't be very intuitive to put external redirects in a file called `internal.txt`, but I think it's worth it to live with this unfortunate consequence. In the future we could change the app to first look for a file with a different name.)
https://lab.civicrm.org/documentation/docs-publisher/-/issues/77
Many issues with poor UX in the search interface
2020-04-26T20:36:00Z
Sean Colsen
Many issues with poor UX in the search interface
This is a general ticket to track progress on multiple, smaller tickets:
* #76
* #75
* #74
* #64
* #70
Most of these are probably upstream issues with [MkDocs Material](https://github.com/squidfunk/mkdocs-material). We should res...
This is a general ticket to track progress on multiple, smaller tickets:
* #76
* #75
* #74
* #64
* #70
Most of these are probably upstream issues with [MkDocs Material](https://github.com/squidfunk/mkdocs-material). We should research and report there.
https://lab.civicrm.org/documentation/docs-publisher/-/issues/76
Search gives no indication that it's running
2021-09-27T11:20:20Z
Sean Colsen
Search gives no indication that it's running
This is an upstream issue with [MkDocs Material](https://github.com/squidfunk/mkdocs-material).
When performing a search, there is a delay as described in #75. During this delay, the search interface should visually indicate to the use...
This is an upstream issue with [MkDocs Material](https://github.com/squidfunk/mkdocs-material).
When performing a search, there is a delay as described in #75. During this delay, the search interface should visually indicate to the user that a search is in progress. Currently users sometimes get confused and press `Enter` as described in #74
https://lab.civicrm.org/documentation/docs-publisher/-/issues/75
Searching guides is slow
2021-09-27T11:20:30Z
Sean Colsen
Searching guides is slow
Searching within a guide is quite slow. The results appear, but after a significant delay. Larger guides have larger delays.
This is an upstream issue with [MkDocs Material](https://github.com/squidfunk/mkdocs-material). There might be ...
Searching within a guide is quite slow. The results appear, but after a significant delay. Larger guides have larger delays.
This is an upstream issue with [MkDocs Material](https://github.com/squidfunk/mkdocs-material). There might be nothing we can do here, but it could be worth researching it a bit.
https://lab.civicrm.org/documentation/docs-publisher/-/issues/74
Pressing Enter when searching reloads current page
2021-09-27T11:20:39Z
Sean Colsen
Pressing Enter when searching reloads current page
This is most likely an upstream issue with [MkDocs Material](https://github.com/squidfunk/mkdocs-material) and we should report it there (or see if it's already been fixed).
Steps to reproduce:
1. Go to a documentation page
1. Enter a...
This is most likely an upstream issue with [MkDocs Material](https://github.com/squidfunk/mkdocs-material) and we should report it there (or see if it's already been fixed).
Steps to reproduce:
1. Go to a documentation page
1. Enter a search term in the search bar
1. Note that it usually takes a while to see results
1. Press `Enter` (maybe because you're not sure if the search is actually running)
1. Expect nothing to happen after pressing `Enter`
1. Observe that the search is canceled and the current page is reloaded.
ref: https://chat.civicrm.org/civicrm/pl/co9zoo34r7rp3f5oyoofk4rqhe
https://lab.civicrm.org/documentation/docs-publisher/-/issues/73
Change CSS for monospace hyperlinks so that it's apparent that they are links
2021-09-27T11:20:53Z
Sean Colsen
Change CSS for monospace hyperlinks so that it's apparent that they are links
In [this page](https://docs.civicrm.org/dev/en/latest/extensions/info-xml/#extension) there are a lot of hyperlinks which contain only monospace text. The current style makes it hard for the user to understand that these are actually lin...
In [this page](https://docs.civicrm.org/dev/en/latest/extensions/info-xml/#extension) there are a lot of hyperlinks which contain only monospace text. The current style makes it hard for the user to understand that these are actually links. Change CSS to make these look different (e.g. underline).
Check with upstream Material Theme to make sure they haven't already made this fix, and consider reporting to them.
https://lab.civicrm.org/documentation/docs-publisher/-/issues/72
Repo URLs specificed in yaml files shold be acceptable with trailing slashes
2020-04-26T20:35:47Z
Sean Colsen
Repo URLs specificed in yaml files shold be acceptable with trailing slashes
[Here](https://chat.civicrm.org/civicrm/pl/4unpux1jgpbpxxjby5ioh89x6o) was a conversation where a trailing slash led to errors when trying to publish a book from a GitHub webhook request. We should allow the trailing slash in the URL so ...
[Here](https://chat.civicrm.org/civicrm/pl/4unpux1jgpbpxxjby5ioh89x6o) was a conversation where a trailing slash led to errors when trying to publish a book from a GitHub webhook request. We should allow the trailing slash in the URL so that this error doesn't happen again.
https://lab.civicrm.org/documentation/docs-publisher/-/issues/71
Update information in the footer/bottom area
2017-07-31T16:05:29Z
josh
josh@civicrm.org
Update information in the footer/bottom area
Would be good to add in a footer consistent with civicrm.org:
© 2005 - 2017, CIVICRM LLC. All rights reserved.
CiviCRM and the CiviCRM logo are trademarks of CIVICRM LLC. Except where otherwise noted, content on this site is licensed un...
Would be good to add in a footer consistent with civicrm.org:
© 2005 - 2017, CIVICRM LLC. All rights reserved.
CiviCRM and the CiviCRM logo are trademarks of CIVICRM LLC. Except where otherwise noted, content on this site is licensed under a Creative Commons Attribution-Share Alike 3.0 United States Licence.
Also, might be nice to expand on the content to "support" (http://civicrm.org/support-us) CiviCRM. Some might want to help with documentation whereas others might want to make a small gift.
https://lab.civicrm.org/documentation/docs-publisher/-/issues/70
Visual mess when search results appear on top of admonitions
2021-09-27T11:21:09Z
Sean Colsen
Visual mess when search results appear on top of admonitions
We probably have some sort small error in our theme customization which is causing this.
For example:
![screenshot63](/uploads/5bc214bf688f26926f52f9d048c304c9/screenshot63.png)
Compare to vanilla Material which does not exhibit this...
We probably have some sort small error in our theme customization which is causing this.
For example:
![screenshot63](/uploads/5bc214bf688f26926f52f9d048c304c9/screenshot63.png)
Compare to vanilla Material which does not exhibit this behavior:
![screenshot64](/uploads/aa052f00fd5c9ba130642871645478b6/screenshot64.png)
CC: @michael
https://lab.civicrm.org/documentation/docs-publisher/-/issues/69
Create theme customization for displaying horizontal rule elements within men...
2021-09-27T11:21:30Z
Sean Colsen
Create theme customization for displaying horizontal rule elements within menu items
We'd like to be able to separate top-level menu items with `<hr>` elements.
If you put this into `mkdocs.yml` it mostly works...
```yaml
- Extensions Development:
- Basics: extensions/index.md
- <hr/>Framework Reference:
```
But th...
We'd like to be able to separate top-level menu items with `<hr>` elements.
If you put this into `mkdocs.yml` it mostly works...
```yaml
- Extensions Development:
- Basics: extensions/index.md
- <hr/>Framework Reference:
```
But the CSS prevents the `<hr>` element from being visible. We need to improve this CSS so that `<hr>` elements within the menu display nicely. Do this as part of our custom theme extension.
This discussion started here: https://chat.civicrm.org/civicrm/pl/nmrzugcc9p81jr4ktp1iydjd5w
https://lab.civicrm.org/documentation/docs-publisher/-/issues/68
Build books to a temporary directory before publishing
2017-10-09T22:39:38Z
Sean Colsen
Build books to a temporary directory before publishing
Building books to a temporary directory before publishing will produce a number of improvements.
The description below is specifically about how using temp dirs will help us avoid broken books. But other benefits come with using temp d...
Building books to a temporary directory before publishing will produce a number of improvements.
The description below is specifically about how using temp dirs will help us avoid broken books. But other benefits come with using temp dirs as well, which are described in more detail in the comments below
### Steps to reproduce
1. Set up a book which has a broken internal hyperlink in some page content.
1. When you go into this book (outside of docs-publisher) and run `mkdocs serve`, you should see something like this:
```
WARNING - The page "index.md" contained a hyperlink to "documentation.md" which is not listed in the "pages" configuration.
```
1. Get docs-publisher to publish this book.
1. Because we publish with `--strict` (generally good) the `mkdocs build` process will fail
1. After the failure, the published book will be broken.
### Suggested implementation
1. When publishing a book, first set up a temporary directory in which to build the files
1. Run `mkdocs build`
1. If everything goes according to plan, replace the live directory with the newly built directory
1. If any errors are encountered trash the built directory and report the errors
This ticket is a simplification of #39
https://lab.civicrm.org/documentation/docs-publisher/-/issues/67
Delete NotifyControllerTest.php
2019-05-21T09:59:45Z
Sean Colsen
Delete NotifyControllerTest.php
@michaelmcandrew you seem to have created [this file](https://lab.civicrm.org/documentation/docs-publisher/blob/9a8d18b585f2731a8c12cb26a9dc2dbc3f9c4172/src/AppBundle/Tests/Controller/NotifyControllerTest.php) but as far as I can tell it...
@michaelmcandrew you seem to have created [this file](https://lab.civicrm.org/documentation/docs-publisher/blob/9a8d18b585f2731a8c12cb26a9dc2dbc3f9c4172/src/AppBundle/Tests/Controller/NotifyControllerTest.php) but as far as I can tell it doesn't do anything.
Can we either:
1. delete it (my preference, since there's really not much there)
1. *or* move it to the `/tests` folder at the root level and add enough code to the file to make it useful.
I'm just trying to do a little housekeeping and this file seemed unnecessary. Perhaps I'm wrong though!
https://lab.civicrm.org/documentation/docs-publisher/-/issues/65
Add 1px Boarder for Images
2021-09-27T11:21:55Z
skessler
Add 1px Boarder for Images
I would like to see a 1px border added to images in the guides. I think this makes it clearer to see and understand the screenshots.
I would like to see a 1px border added to images in the guides. I think this makes it clearer to see and understand the screenshots.
Docs Publisher 2019
homotechsual
homotechsual
https://lab.civicrm.org/documentation/docs-publisher/-/issues/63
Move this repo to GitLab
2017-04-30T22:16:43Z
Sean Colsen
Move this repo to GitLab
*Created by: seanmadsen*
We are starting to test the waters with GitLab at https://lab.civicrm.org. I'd like to migrate this repository (and our workflow) there. Is that okay with others? I'd especially like to get the go-ahead from @mi...
*Created by: seanmadsen*
We are starting to test the waters with GitLab at https://lab.civicrm.org. I'd like to migrate this repository (and our workflow) there. Is that okay with others? I'd especially like to get the go-ahead from @michaelmcandrew here. What do you think?
https://lab.civicrm.org/documentation/docs-publisher/-/issues/62
Re-title wiki.civicrm.org so Docs site is preferred
2017-04-30T22:16:43Z
xurizaemon
Re-title wiki.civicrm.org so Docs site is preferred
Currently searches for "civicrm docs" have the wiki at the top. By now I think we should be preferring to land people on docs.civicrm.org and linking to "legacy" docs in the wiki when necessary.
Not sure what is required to re-title w...
Currently searches for "civicrm docs" have the wiki at the top. By now I think we should be preferring to land people on docs.civicrm.org and linking to "legacy" docs in the wiki when necessary.
Not sure what is required to re-title wiki.civicrm.org "CiviCRM Wiki" or "Legacy Documentation" to denote this, so opening an issue to propose it.
![screen shot 2017-04-22 at 11 51 08 pm](https://cloud.githubusercontent.com/assets/105608/25304220/f191eb42-27b6-11e7-8990-86498772896b.png)
https://lab.civicrm.org/documentation/docs-publisher/-/issues/60
Automatic publishing for books hosted in GitLab
2019-05-21T10:18:44Z
Sean Colsen
Automatic publishing for books hosted in GitLab
*Created by: seanmadsen*
We can automatically publish books when changes are made, but only if the book is hosted on GitHub (and if the owner configures the webhooks correctly). It'd be great to get something like this working for GitLa...
*Created by: seanmadsen*
We can automatically publish books when changes are made, but only if the book is hosted on GitHub (and if the owner configures the webhooks correctly). It'd be great to get something like this working for GitLab too, so that we can automatically publish books which are hosted in GitLab.
michael
michael
https://lab.civicrm.org/documentation/docs-publisher/-/issues/56
Say "guides" instead of "books"
2017-04-30T22:16:43Z
Sean Colsen
Say "guides" instead of "books"
*Created by: seanmadsen*
Remove language about "books", and change it to "guides" instead.
I think the home page is the only place where this change is needed within this repository.
Convo originally started by @michaelmcandrew ...
*Created by: seanmadsen*
Remove language about "books", and change it to "guides" instead.
I think the home page is the only place where this change is needed within this repository.
Convo originally started by @michaelmcandrew [here](https://chat.civicrm.org/civicrm/pl/ksz16ognw3dxim6s8mmixh69pe)