-
Notifications
You must be signed in to change notification settings - Fork 122
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
Python guide: Update landing page of the guide #520
Comments
Hi @gkunz , Main purpose: In some organizations designers must study this type of content. Its designed as a read-through/self study where you do not suffer studying it. Issues we have seen in secure coding guides that we like improve on:
How to read: Good learning material allows a to study in a continues line. The CWE structure we use does not allow that as one can see in: I believe It is important to allow a designer to study the content in their natural habitat meaning programming IDE with a cloned git. Not on some web-server regardless of confluence or what not. How to contribute to the guide Overall I like to avoid overloading the main page. What we need is:
Some of this type of content exists partially on our internal confluence page. Correct broken links Needs automation Make the size of the tables more consistent We had a hack for it |
Hi @myteron, all very good input. It seems, we may want to address some of these points individually. I'd rather leave writing about the purpose to you as the driver, but I'll take on other, smaller things such as linking to a contributor guide (externally of the main landing page), the tables (the linter config can alwasy be updated - it should serve us, not the other way around). |
The landing page of the guide should be updated to make it more consumable for readers. Improvements include:
The text was updated successfully, but these errors were encountered: