Title: [Suggestion] Restructuring documentation · Issue #697 · pythonindia/junction · GitHub
Open Graph Title: [Suggestion] Restructuring documentation · Issue #697 · pythonindia/junction
X Title: [Suggestion] Restructuring documentation · Issue #697 · pythonindia/junction
Description: Since Junction's documentation is distributed at various places and requires restructuring, I would like to propose the following structure for the readthedocs documentation, suggesting appropriate location for the existing documentation...
Open Graph Description: Since Junction's documentation is distributed at various places and requires restructuring, I would like to propose the following structure for the readthedocs documentation, suggesting appropriate...
X Description: Since Junction's documentation is distributed at various places and requires restructuring, I would like to propose the following structure for the readthedocs documentation, suggesting appropr...
Opengraph URL: https://github.com/pythonindia/junction/issues/697
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Suggestion] Restructuring documentation","articleBody":"Since Junction's documentation is distributed at various places and requires restructuring, I would like to propose the following structure for the readthedocs documentation, suggesting appropriate location for the existing documentation on GitHub wiki. Creating a structure before writing pages will help us write individual pages and recollect them easily.\r\n\r\nI suggest to have 4 level of documentation:\r\n----\r\n1. **Welcome Page**\r\n - With table of contents reference for whole project for easier and efficient navigation.\r\n - Link to the \"docs\" labelled issue page to welcome more documentation contribution.\r\n - License at the end (optional)\r\n\r\n2. **User Level,** to welcome more use of the project among speakers and by other conference organizers with following sections/pages.\r\n - Installation Guide for local and production environment for different platforms.\r\n - Quick Start / Getting Started guide, which will cover the steps after installation to use the project. A brief on how one can use the project to setup their CFP acceptance system.\r\n - Features the project offers\r\n - How-To(s) to setup and use the project as described [here](https://github.com/pythonindia/junction/issues/627) (migrate content from existing Github wiki over here)\r\n - FAQ section\r\n - [Best Practices](https://github.com/pythonindia/junction/wiki/Speaker-best-practices) and [speaker guidelines](https://github.com/pythonindia/junction/wiki/Speaker-Guidelines)\r\n - Link to release notes page for the sake of history.\r\n\r\n3. **Contribution** page\r\n - Contribution guidelines with best practices to create a patch\r\n - License declaration\r\n - Pre-requisites such as git/python and django and sharing relevant resources\r\n - Redirection to easy-to-fix label issues on github\r\n - Community details, where to contact for help\r\n - Redirection to Development/developer page\r\n\r\n4. **Development Page**, for developers working on the project\r\n - Link to contribution guidelines\r\n - Getting started page link / Installation Page link\r\n - API resources\r\n - Structure of the project, detailing on the individual application\r\n----\r\n\r\n#631 \r\n#627 \r\n#589","author":{"url":"https://github.com/miphilomath","@type":"Person","name":"miphilomath"},"datePublished":"2020-06-13T15:41:14Z","url":"https://github.com/pythonindia/junction/issues/697"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:a922c829-75f9-0f5f-a4d8-734bb6a51f23 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9E52:5314B:13D1F0D:191F149:6AFF9CA8 |
| html-safe-nonce | 646e0609f6753af701f0196625f19da46e8ef6838cd9a829ed97ed98fe3a71d5 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5RTUyOjUzMTRCOjEzRDFGMEQ6MTkxRjE0OTo2QUZGOUNBOCIsInZpc2l0b3JfaWQiOiIyNTI4MDA3NzAxOTk3MjY0MDQwIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 18fc2a4fc8863afc5053d5748120dd45f4493794f0ec3b89dd5eb73a887916bb |
| hovercard-subject-tag | issue:638183119 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/pythonindia/junction/697/issue_layout |
| twitter:image | https://opengraph.githubassets.com/43e5d44d2e3a1d865872684ead6167ec6fe04e17fa2fb79608b51294f7be2789/pythonindia/junction/issues/697 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/43e5d44d2e3a1d865872684ead6167ec6fe04e17fa2fb79608b51294f7be2789/pythonindia/junction/issues/697 |
| og:image:alt | Since Junction's documentation is distributed at various places and requires restructuring, I would like to propose the following structure for the readthedocs documentation, suggesting appropriate... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | miphilomath |
| hostname | github.com |
| expected-hostname | github.com |
| None | 2c75d045e8c84b51e2ac680086a6dd1eeaf2bc15b82137d22ee5106835d6256c |
| turbo-cache-control | no-preview |
| go-import | github.com/pythonindia/junction git https://github.com/pythonindia/junction.git |
| octolytics-dimension-user_id | 1763047 |
| octolytics-dimension-user_login | pythonindia |
| octolytics-dimension-repository_id | 27966694 |
| octolytics-dimension-repository_nwo | pythonindia/junction |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 27966694 |
| octolytics-dimension-repository_network_root_nwo | pythonindia/junction |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 525b66d22c4f7e6bb8b62934bec198964f7e8b93 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width