Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Update links to bokehplots.com, gitter and mailing-list #9080

Closed
timsnyder opened this issue Jul 14, 2019 · 7 comments · Fixed by #9085
Closed

[DOCS] Update links to bokehplots.com, gitter and mailing-list #9080

timsnyder opened this issue Jul 14, 2019 · 7 comments · Fixed by #9085

Comments

@timsnyder
Copy link
Contributor

Dev documentation still points to https://bokehplots.com/pages/contact.html. bokehplots.com has out-dated information and is being deprecated. On the gitter @bryevdv said he want's those links to point to bokeh.org instead.

@timsnyder
Copy link
Contributor Author

@bryevdv , there are a number of links out to bokehplots.com from the release notes in sphinx/source/docs/releases/ and on blog.bokeh.org. What are your thoughts on updating those links?

It's probably right to leave them alone. I think most people understand that the release notes make sense at the time of release but things get updated as newer releases are made. However, I could see how you might not want people to hit 404's if bokehplots.com eventually gets taken down.

@bryevdv
Copy link
Member

bryevdv commented Jul 14, 2019

If there is a reasonable new link to update to, my ideal preference is definitely that they be updated. That said, I don't think it's a high priority so if it's a lot of work, or excessively tedious, leaving them alone is also fine.

@timsnyder
Copy link
Contributor Author

There aren't that many. I think most of them are links to the "roadmap" and I see https://bokeh.org/roadmap/ that looks like the right place to link.

After taking the contacts.rst out, I was curious whether Sphinx checked for broken refs in the documentation. Looks like there is a configuration called 'nitpicky' that can warn about those. https://www.sphinx-doc.org/en/master/usage/configuration.html?highlight=nitpicky#confval-nitpicky

Do you guys have any experience with trying to turn on nitpicky? I'm building the docs right now with it to see if it generates a bunch of garbage or points me at places where contacts needs to be updated.

@bryevdv
Copy link
Member

bryevdv commented Jul 14, 2019

The issue with checking links during the build is that it makes the build take longer but more importantly, sometimes the build gets broken due to things outside your control (e.g. we used to check GH issue links, but occasionally GH is down and when that happens the build broke for no good reason). I would very much like to start performing link checks on our site but I think I'd rather do it outside the context of builds (also because there are sites besides the docs that could be checked)

@timsnyder
Copy link
Contributor Author

Makes sense. Also looks like sphinx nitpicky gets confused about what's available in the autogenerated refguide stuff:
Warning, treated as error: /home/ubuntu/environment/sphinx/source/docs/dev_guide/models.rst:41:py:class reference target not found: bokeh.core.properties.Property

@timsnyder
Copy link
Contributor Author

@bryevdv , has the bokeh-dev mailing list mentioned on the bindings page moved onto the discourse as well?

@bryevdv
Copy link
Member

bryevdv commented Jul 14, 2019

Bokeh dev mailing list was shuttered a long time ago. The nearest thing now is the Development category on the Discourse:

https://discourse.bokeh.org/c/development

@timsnyder timsnyder changed the title [DOCS] Remove links to bokehplots.com/pages/contacts [DOCS] Update links to bokehplots.com, gitter and mailing-list Jul 15, 2019
@bryevdv bryevdv added this to the 1.3 milestone Jul 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants