Skip to content

Commit

Permalink
User table doc (#69)
Browse files Browse the repository at this point in the history
* Add files

* Update files

* Add user table manual

* Update yml and index files

* Update headers
  • Loading branch information
ketankartoza authored Aug 9, 2024
1 parent 1eb7773 commit f18a3c5
Show file tree
Hide file tree
Showing 48 changed files with 1,561 additions and 9 deletions.
20 changes: 15 additions & 5 deletions docs/mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,18 @@ nav:
- Home:
- index.md
- quick_installation.md
- Developers:
- developer/index.md
- Documentation:
- "Data model": developer/data-model.md
- "Hyrax Configuration": developer/hyrax-config.md
- Administrators:
- administrator/index.md
- Guide:
- administrator/guide/index.md
- Manual:
- administrator/manual/index.md
- Django Administration: administrator/manual/django-admin.md
- Django Tables: administrator/manual/django-table.md
- Add Record in Table: administrator/manual/django-add-record.md
- Edit Record in Table: administrator/manual/django-change-record.md
- Developers:
- developer/index.md
- Documentation:
- "Data model": developer/data-model.md
- "Hyrax Configuration": developer/hyrax-config.md
86 changes: 86 additions & 0 deletions docs/src/about/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
---
title: TomorrowNow - Global Access Platform (GAP)
summary: TomorrowNow - GAP is next-gen weather and climate data and services.
- Danang Tri Massandy
- Irwan Fathurrahman
- Ketan Bamniya
date: 2024-08-01
some_url: https://github.com/kartoza/tomorrownow_gap
copyright: Copyright 2023, TomorrowNow
contact: [email protected]
license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
---

# Contributor covenant code of conduct

## Our pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
education, socio-economic status, nationality, personal appearance, race,
religion, or sexual identity and orientation.

## Our standards

Examples of behaviour that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behaviour by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behaviour and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behaviour.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behaviour may be
reported by contacting the project team. All complaints will be reviewed and
investigated and will result in a response that is deemed necessary and
appropriate to the circumstances. The project team is obligated to maintain
confidentiality with regard to the reporter of an incident. Further details of
specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org
147 changes: 147 additions & 0 deletions docs/src/about/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
---
title: TomorrowNow - Global Access Platform (GAP)
summary: TomorrowNow - GAP is next-gen weather and climate data and services.
- Danang Tri Massandy
- Irwan Fathurrahman
- Ketan Bamniya
date: 2024-08-01
some_url: https://github.com/kartoza/tomorrownow_gap
copyright: Copyright 2023, TomorrowNow
contact: [email protected]
license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
---

# Contributing to [PROJECT_NAME]

First off, thanks for taking the time to contribute! 🎉 😘 ✨

The following is a set of guidelines for contributing to this project.
These are mostly guidelines, not rules. Use your best judgment, and
feel free to propose changes to this document in a pull request.

## Reporting bugs

Bugs are tracked as GitHub issues. Search the list and try reproduce on your
local machine with a clean profile before you create an issue.
When you create an issue, please provide the following information by filling
in the template.

Explain the problem and include additional details to help maintainers reproduce the problem:

* **Use a clear and descriptive title** for the issue to identify the problem.
* **Describe the exact steps which reproduce the problem** in as many details
as possible. Don't just say what you did, but explain how you did it. For
example, if you moved the cursor to the end of a line, explain if you used a
mouse or a keyboard.
* **Provide specific examples to demonstrate the steps.** Include links to
files or GitHub projects, or copy/paste-able snippets, which you use in those
examples. If you're providing snippets on the issue, use Markdown code blocks.
* **Describe the behaviour you observed after following the steps** and point
out what exactly is the problem with that behaviour.
* **Explain which behaviour you expected to see instead and why.**
* **Include screenshots and animated GIFs** which show you following the
described steps and clearly demonstrate the problem.

## Suggesting enhancements

In case you want to suggest an enhancement, please follow this guideline to
help maintainers and the community understand your suggestion.
Before creating suggestions, please check [issue
list](https://github.com/project-name/repository/labels/feature) if
there's already a request.

Create an issue and provide the following information:

* **Use a clear and descriptive title** for the issue to identify the
suggestion.
* **Provide a step-by-step description of the suggested enhancement** in as
many details as possible.
* **Provide specific examples to demonstrate the steps.** Include
copy/paste-able snippets which you use in those examples, as Markdown code
blocks.
* **Include screenshots and animated GIFs** which helps demonstrate the steps
or point out the part of project which the suggestion is related to.
* **Explain why this enhancement would be useful** to most users.
* **List some other text editors or applications where this enhancement
exists.**

## First code contribution

Unsure where to begin contributing? You can start by looking
through these `document`, `good first issue` and `help wanted` issues:

* **document issues**: issues which should be reviewed or improved.
* **good first issues**: issues which should only require a few lines of code,
and a test or two.
* **help wanted issues**: issues which should be a bit more involved than
beginner issues.

## Pull requests

### Development workflow

* Set up your development environment
* Make change from a right branch
* Be sure the code passes tests
* Make a pull request

### Development environment

* Prepare your machine and it's packages installed.
* Checkout our repository
* Install dependencies by `pip install -r REQUIREMENTS-dev.txt`

### Make changes

#### Checkout a branch

* **master**: PR Base branch.
* **production**: lastest release branch with distribution files. Never make a PR on this.
* **gh-pages**: API docs, examples and demo

#### Check code style

Run the pylance extension and make sure all the tests pass.

#### Test

Run `TODO` and verify all the tests pass.
If you are adding new commands or features, they must include tests.
If you are changing functionality, update the tests if you need to.

#### Commit

Follow our [commit message conventions](../developer/guide/templates/commit-message-convention.md).

### Yes! Pull request

Make your pull request, then describe your changes.

#### Title

Follow other PR title format on below.

```
<Type>: Short Description (fix #111)
<Type>: Short Description (fix #123, #111, #122)
<Type>: Short Description (ref #111)
```

* capitalize first letter of Type
* use present tense: 'change' not 'changed' or 'changes'

#### Description

If it has related issues, add links to the issues(like `#123`) in the description.
Fill in the [Pull Request Template](../developer/guide/templates/pull-request-template.md) by check your case.

## Code of conduct

This project and everyone participating in it is governed by the [Code of
Conduct](code-of-conduct.md). By participating, you are expected to uphold this
code. Please report unacceptable behaviour to [email protected].

> This guide is based on [atom contributing
guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md),
[CocoaPods](http://guides.cocoapods.org/contributing/contribute-to-cocoapods.html)
and [ESLint](http://eslint.org/docs/developer-guide/contributing/pull-requests)
17 changes: 17 additions & 0 deletions docs/src/about/disclaimer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: TomorrowNow - Global Access Platform (GAP)
summary: TomorrowNow - GAP is next-gen weather and climate data and services.
- Danang Tri Massandy
- Irwan Fathurrahman
- Ketan Bamniya
date: 2024-08-01
some_url: https://github.com/kartoza/tomorrownow_gap
copyright: Copyright 2023, TomorrowNow
contact: [email protected]
license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
---

# Disclaimer
<!-- To Be Populated -->

Disclaimer about project.
7 changes: 7 additions & 0 deletions docs/src/about/img/naming-convention.README
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Image naming convention

Images should be named according to reference doc, sub-section and order in the document.
e.g.

- The 1st image in instructions regarding zooming will be something like zooming-1, the 2nd image will be zooming-2, etc.
- The 1st image in quickstart regarding logging in will be login-1, etc
35 changes: 35 additions & 0 deletions docs/src/about/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: TomorrowNow - Global Access Platform (GAP)
summary: TomorrowNow - GAP is next-gen weather and climate data and services.
- Danang Tri Massandy
- Irwan Fathurrahman
- Ketan Bamniya
date: 2024-08-01
some_url: https://github.com/kartoza/tomorrownow_gap
copyright: Copyright 2023, TomorrowNow
contact: [email protected]
license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
---

# AboutNotARobot

## License

Published under AGPL-3. See the [full license](license.md) text.

## Contributors
<!-- Tim is an example on what a contributor should look like -->

| Contributor | GitHub Handle | |
| ----------- | ------------- |-|
| Hugh Mann| [NotARobot]() | <img src="https://github.com/[username].png" alt= “” width="64" height="64"> |
| Tim Sutton | [timlinux](https://github.com/timlinux) | <img src="https://github.com/timlinux.png" alt= “” width="64" height="64"> |

## Project funders/backers

This project was conceptualized and initially funded by [FUNDER_1]().

## Logos

Another fine project contributed to by: [Kartoza.com](https://kartoza.com)
![Kartoza Logo](../img/KartozaLogo-320x132.png)
Loading

0 comments on commit f18a3c5

Please sign in to comment.