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.

Sign up for GitHub

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

Jump to bottom

Create Intended Audience Section for documentation #5401

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Create Intended Audience Section for documentation #5401

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4435d14
Update README.md
COP3502-StudentA Sep 24, 2024
4b98adf
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,44 @@ production-ready Django projects quickly.
- If you have problems with Cookiecutter Django, please open [issues](https://github.com/cookiecutter/cookiecutter-django/issues/new) don't send
emails to the maintainers.

## Table of Contents

- [IntendedAudience](#IntendedAudience)
- [Features](#Features)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

## Optional Integrations is missing

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A ToC would be a good addition!

- [Constraints](#Constraints)
- [Contributing](#contributing)
- [License](#license)
- [Usage](#Usage)
- [Community](#Community)
- [Releases](#Releases)
- [Articles](#Articles)

## IntendedAudience
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing a space here


The purpose of this section is to outline the prerequisite knowledge that potential users need to effectively create projects
with this application. Links will be provided to supplemental resources to help users get up to speed.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are reading a readme, not a 300 pager. So the introduction is way to long and, in my opinoin, unnecessary.


This application's main purpose is to increase the efficiency of django applications by defining project specifications
beforehand, thus preventing missing dependencies later on in the development process.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence outlines the intended audience nicely 👍


Users of this software should have working proficiency in building django applications. For new users to Django, please
refer to the official documentation: [here](https://docs.djangoproject.com/en/5.1/)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not link to a version here, otherwise it will be out of sync in no time when we forget to update the corresponding version. If you want to link to a version: we are at 5.0 at the time.


To use this application most effectively, users should have the scope of their application defined before beginning to create
a new project.

Example's of defined scope include:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What means an example of defined scope?

You are trying to say that you need prior knowledge of docker etc right?


- docker usage
- cloud provider
- postgresql version
See the [Usage](#Usage) section for a clear guide to the project creation process.

For more information about these specific requirements, see the documentation provided:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do people really benefit from linking to these sources?

(docker)[https://www.docker.com/]
(PostgreSQL)[https://www.postgresql.org/]
(AWS)[https://aws.amazon.com/]

## Features

- For Django 5.0
Expand Down