frappe / frappe_io

Website for Frappe

Website of the Frappe Framework

This is the website of the frappe framework, frappe.io. It is, naturally, built on the frappe framework.

License

CC-BY-NC-SA

frappe_io's Issues

Getting Error Code 404 -In the side bar for the link Create Frappe App

While i was going through frappe framework , i encountered a 404 error code for the below link.

Link:

https://frappe.io/docs/user/en/create-frappe-app

Who can take charge of the issue unrelated to the documentation

Hello @frappe team.

Who can take charges of non-documentation related issues? With blog, logins, contact form etc etc?

Document building procedure and implement a CI

Move documentation in the frappe repo

I'd recommend you move the documentation inside the frappe repo so that:

1. the documentation changes track the code changes
2. people who do PR can update the documentation without getting crazy
3. simple checks can be implemented to enforce it

I have been working on frappe for months and never saw this repo

Bug: Accessing the blog returns sever error

I was checking the official blog from time to time, but today it was impossible due to this server error:

Server Error

Traceback (innermost last):
File "/home/frappe/frappe-bench/apps/frappe/frappe/app.py", line 69, in application
response = frappe.website.render.render(request.path)
File "/home/frappe/frappe-bench/apps/frappe/frappe/website/render.py", line 40, in render
data = render_page(path)
File "/home/frappe/frappe-bench/apps/frappe/frappe/website/render.py", line 107, in render_page
return build(path)
File "/home/frappe/frappe-bench/apps/frappe/frappe/website/render.py", line 114, in build
return build_page(path)
File "/home/frappe/frappe-bench/apps/frappe/frappe/website/render.py", line 127, in build_page
context = get_context(path)
File "/home/frappe/frappe-bench/apps/frappe/frappe/website/context.py", line 16, in get_context
context = build_context(context)
File "/home/frappe/frappe-bench/apps/frappe/frappe/website/context.py", line 54, in build_context
ret = module.get_context(context)
File "/home/frappe/frappe-bench/apps/frappe/frappe/templates/pages/list.py", line 22, in get_context
context.update(get(**frappe.local.form_dict))
File "/home/frappe/frappe-bench/apps/frappe/frappe/templates/pages/list.py", line 58, in get
set_route(new_context)
File "/home/frappe/frappe-bench/apps/frappe/frappe/templates/pages/list.py", line 73, in set_route
context.route = context.doc.get_route()
TypeError: 'NoneType' object is not callable

Tested on Firefox 38.7.1 ESR and Chromium 49.0.2623.108

Broken facebook login

https://frappe.io/login#login

Document bench command line options

Bench command line options maybe can be documented using sphinxcontrib.autoprogram

Add updated feature list

https://discuss.erpnext.com/t/frappe-does-not-have-a-feature-list/60455

Update about us photos and team members

Update the photos and team members in about us section

Broken google login

The redirect URI in the request, https://frappe.io/api/method/frappe.www.login.login_via_google, does not match the ones authorized for the OAuth client. To update the authorized redirect URIs, visit: https://console.developers.google.com/apis/credentials/oauthclient/907131654131-q418pk6t93m1v3n085uqlmliomg9tnpm.apps.googleusercontent.com?project=907131654131

https://frappe.io/login#login

Broken link in frappe documentation

On clicking Meta, the link is not working in https://frappe.io/docs/user/en/understanding-doctypes

Link Broken to Example Website for Frappe

https://frappe.io/blog/erpnext-features/build-a-dynamic-seo-friendly-website-from-erpnext

Broken github login

Traceback (most recent call last):
File "/home/frappe/frappe-bench/apps/frappe/frappe/app.py", line 62, in application
response = frappe.api.handle()
File "/home/frappe/frappe-bench/apps/frappe/frappe/api.py", line 58, in handle
return frappe.handler.handle()
File "/home/frappe/frappe-bench/apps/frappe/frappe/handler.py", line 24, in handle
data = execute_cmd(cmd)
File "/home/frappe/frappe-bench/apps/frappe/frappe/handler.py", line 63, in execute_cmd
return frappe.call(method, **frappe.form_dict)
File "/home/frappe/frappe-bench/apps/frappe/frappe/init.py", line 1074, in call
return fn(*args, **newargs)
TypeError: login_via_github() missing 1 required positional argument: 'code'

BTW error code should NOT be exposed for login functions!

Frappe Docs : Reporting Page Broken.

Hi,

As I was learning with the help of docs, more about Frappe & Codes. I noticed some of the pages doesn't have images also some of the page layouts are broken. When I reached to Github Repository of those docs, found everything to be correct.

While generating the page, no header and footer are going to render there.

Broken Page Link: https://frappe.io/docs/user/en/guides/portal-development/generators and
Github Repo MarkDown Link are: https://github.com/frappe/frappe_io/blob/master/frappe_io/www/docs/user/en/guides/portal-development/generators.md

Search

THERE IS NO SEARCH

A documentation with no search...

Would be fixed by using Sphinx

Contradiction between suggested content of my.cnf file

Tutorial says we are supposed to add following to my.cnf file:

[mysqld]
innodb-file-format=barracuda
innodb-file-per-table=1
innodb-large-prefix=1
character-set-client-handshake = FALSE
character-set-server = utf8mb4
collation-server = utf8mb4_unicode_ci

[mysql]
default-character-set = utf8mb4

However, the Hitchhiker's guide to installing Frappe says:

[mysqld]
character-set-client-handshake = FALSE
character-set-server = utf8mb4
collation-server = utf8mb4_unicode_ci

[mysql]
default-character-set = utf8mb4

Following the Hitchhiker's guide worked well while following the tutorial instruction caused my mariaDB server to not start.
I am on Linux mint 19.

broken links

https://frappe.io/docs/current/models/models

[ui] add controls to navigate to either previous or next blog post

It would be really useful to be able to navigate through blog posts forwards and backwards. Especially when using mobile device.

[UX] Contact Us page - Confirmation message

As reported by the prospect:

If someone send us a message using Contact page, then on submission of the message, there should be prompt.

https://frappe.io/about#contact

Guide for custom Social Login Key

It would be nice to have a guide for setting up custom Social Login. Currently there is only a guide for the most common providers.

In order to set up self-hosted NextCloud as a provider I needed to look through very incomplete documentation, some loosely connected discussions and GitHub issues as well as code itself, to understand what's going on. It shouldn't be required to read the code in order to set this up.

I'll be working on better NextCloud integration shortly, so I may write something. I'm leaving this issue for future, until I write it, so that others can see that someone actually got it working.

Security Issue not listed in Frappe Security Bulletin

I found a security issue few years ago, my issue is not listed to this site https://frappe.io/security.
Here's my original report. https://github.com/frappe/erpnext/issues/11750.

More marked hierarchical structure

The documentation is not hierarchical enough, there are docs, tutorials etc etc but the structure is not clear

[ui] add control to reset category filter in blog

Once one has filtered blog posts by category, there is no control to reset category filter.
Can be done in similar way, as here at Github:

Cleaning stale branches

@rmehta these branches are yours are they still useful or can they be cleaned up?

Error: Value too big, Maximum character allowed is 140

I’m uploading 100 customer details in item. While mapping the customer’s the error is coming " Value too big for customer Code, Max character allowed is 140" . The ‘customer_code’ in item is a data field where the sum of all the character of customer name from the customer details table should be less then 140.

How can i increase the maximum character allowed in customer_code to 500 or more?

Issue in Scheduled Tasks chapter (Chap-18) of tutorial

There is an importError while running the tasks.py defined in this chapter.
datediff and format_date can't be imported.

As scheduler is disabled while creating new-site, can i see the actual output of tasks.py? or how can i check the output of scheduler?

My tasks.py is in-

apps/library_management/library_management/tasks.py

Missing Server API pages

No Server API pages are in the new site, when can we expect this to be posted. They really help alot in developing applications for Frappe.

Promote frappe_docker instead of bench

Hi,
You should promote https://github.com/frappe/frappe_docker instead of bench in the main page.

It's so much easier to get started with development on docker, especially with the new VScode integration.

David

Error 500 for one page

this url : https://frappe.io/docs/user/en/guides/automated-testing/qunit-testing
give error 500

Improve UX on Send in Write to Us

https://frappe.io/about#contact

No message on sent

Frappe Python API documentation based on Sphinx

https://www.tjelvarolsson.com/blog/how-to-generate-beautiful-technical-documentation/

`Next` and `Previous` Links for navigating in the documentation page

Hello guys,

I got to know about Frappe recently. I am going through the docs at the moment and this is not an issue per se. I want to suggest that you include next and previous links to this guide .
Something similar to this one highlighted in the doc from Next.js

I think it will make the doc better in terms of user experience.

Keep up the good works.

Cheers!

Listing Child Table Objects

An example of the REST formatting required for obtaining data from Child Tables in DocTypes should be added to this file:

    frappe_io/frappe_io/www/docs/user/en/guides/integration/rest_api/listing_documents.md

GSTR Report is not generating.

I have some sales with GST done but it is not showing in the GSTR-1 Report. on creating a new report everytime it show " Nothing to show".

Charts related JS shouldn't be loaded on all pages

Unnecessary 350KB of network request 🤷

frappe_io/frappe_io/hooks.py

Line 37 in 97abc2d

web_include_js = ["charts-demo.bundle.js"]

[Question] Tutorial image for Desk UI is misleading, under the start section.

What the tutorial suggests I should see:

What actually came up:

I follwed the tutorial sequentially, I only installed the libray app on one site. I'm supprised that my results don't match what is expected. I'm I missing something?

Broken links master issue

Broken link - https://frappe.io/docs/user/en/create-frappe-app

Re this user report https://discuss.erpnext.com/t/broken-link-https-frappe-io-docs-user-en-create-frappe-app/55528

In the online docs, in the left sidebar menu here https://frappe.io/docs/user/en, the 'Creating a Frappe App' menu item links to here https://frappe.io/docs/user/en/create-frappe-app

But that link reference results in a 404 not found since create-frappe-app destination cannot be found here:

https://github.com/frappe/frappe_io/tree/master/frappe_io/www/docs/user/en

The question is where is create-frappe-app or has the file been deliberately deleted?

That will determine how the left menu will need to be edited
https://github.com/frappe/frappe_io/blob/master/frappe_io/www/docs/_sidebar.json

Evaluate https://wiki.erpnext.org/display/ENG/Basics

Interesting content that should be evaluated for merge

2020 DOCUMENTATION REVAMP MASTER ISSUE

The documentation has been a little bit forgotten about.

I have taken in my hands to manage existing PR and issues, then find a way to improve the existing documentation. This may take a long time, and help is needed.

For now, the rough plan is the following:

STAGE 1 (this one is laid out and uncontroversial):

• Cleanup the issues
• Validate PR and merge into develop
• Ask Frappe team to merge PR I am not qualified to work on
• Improve https://github.com/frappe/frappe_docker documentation to cover unattended installs
• Prepare an unattended install script in https://github.com/frappe/frappe_docker
• Setup automated CI builds here, and document build
• Cleanup and fix broken links
• Automatically test broken links in CI
• Verify optimization of images
• Merge develop to master

At the end of STAGE 1, frappe documentation should be better maintained and maintainable.

STAGE 2 (still to be discussed - very hypothetical - you're welcome to propose changes):

• Frappe team is not going to like this... Convert documentation from Frappe to Sphinx... keep reading why
• Fix ToC and hierarchical structure of the documentation so it's more logical
• Creating two sister PR. One adds all the frappe python API documentation into the frappe repository itself through python strings. The second one deletes such documentation from the docs.
• Integrate Sphinx autodoc to automatically generate frappe python API documentation
• write new pages highlighting the interesting functions that were previously manually documented
• Conduct an analysis of existing page and verify what links get broken. Create redirects as needed.
• If frappe teams want coherent UI, someone from the frontend team should create an ad-hoc sphinx theme
• Get frappe to serve the static HTML of the documentation
• Move documentation to the frappe repo.
• find a way to build and deploy from frappe repo
• merge to master

At the end of stage 2 documentation is truly maininable. Python API is built automatically, and code can be documented in a couple of minutes wherever the typical "How can i do XXX" issues arises in the forum. Documentation can be written and built very quickly thanks to Sphinx. New documentation can now be written linking to python API.

STAGE 3 (still to be discussed - very hypothetical - you're welcome to propose changes):

• Create manual OpenAPI to document frappe REST API. If frappe wants to contribute, this could also be done automatically
• Replace frappe rest documentation with Sphinx-OpenAPI integration
• merge to master

At the end of STAGE 3 REST API is properly documented

STAGE 3 (still to be discussed - very hypothetical - you're welcome to propose changes):

• Create Javascript API documentation with Sphinx
  (...)
• merge to master

At the end of STAGE 4 Javascript API are more easy to document.

STAGE 5:

• eat 1kg of salted caramel icecream

---

A couple of notes on how I work:

• I have the bad habit of writing issues banging my head on the keyboard in a hurry then rewrite them. Please check the last edit on github
• Nothing will be merged to master by me unless approved by the frappe team

Images on page `customize-erpnext/custom-doctype` are not available

On this page:
https://frappe.github.io/erpnext/user/manual/en/customize-erpnext/custom-doctype
following images are not available:
https://frappe.github.io/erpnext/assets/img/setup/customize/doctype-all-fields.png
https://frappe.github.io/erpnext/assets/img/setup/customize/doctype-permissions.png
https://frappe.github.io/erpnext/assets/img/setup/customize/doctype-list-view.png
https://frappe.github.io/erpnext/assets/img/setup/customize/doctype-book-added.png

frappe.io certificate expired March 9, 2020. Error code: SEC_ERROR_EXPIRED_CERTIFICATE

Re the Developer Docs hosted here https://frappe.io/docs

Chrome and Firefox just now report this:

Websites prove their identity via certificates, which are valid for a set time period. The certificate for frappe.io expired on March 9, 2020.

Error code: SEC_ERROR_EXPIRED_CERTIFICATE

bug: blog categories https://frappe.io/blog/*** don't filter posts

Clicking on any https://frappe.io/blog/*** category (eg https://frappe.io/blog/erpnext-features) doesn't filter the posts — blog keeps displaying full list of posts as if you haven't chosen any category.

Environment:
Mozilla Firefox ESR 45.4.0

Verify SEO of the documentation

Why google never finds the piece of documentation I need? this doesn't happen with other projects.

Maybe a SEO issue?

Rhetorical questions, I have assigned this issue to me