diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/1234/index.html b/1234/index.html new file mode 100644 index 0000000..a8a6b2d --- /dev/null +++ b/1234/index.html @@ -0,0 +1,15 @@ + + + + + + Redirecting... + + + + + + +Redirecting... + + diff --git a/404.html b/404.html new file mode 100644 index 0000000..e68b074 --- /dev/null +++ b/404.html @@ -0,0 +1,1547 @@ + + + + + + + + + + + + + + + + + + + + + + Project Name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/about/code-of-conduct/index.html b/about/code-of-conduct/index.html new file mode 100644 index 0000000..7af6b12 --- /dev/null +++ b/about/code-of-conduct/index.html @@ -0,0 +1,722 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + +
+1. + Skip to content + +
+
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

1. Contributor covenant code of conduct

+

1.1 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.

+

1.2 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
    • +
+

1.3 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.

+

1.4 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.

+

1.5 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.

+

1.6 Attribution

+

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

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/about/contributing/index.html b/about/contributing/index.html new file mode 100644 index 0000000..0cd11c1 --- /dev/null +++ b/about/contributing/index.html @@ -0,0 +1,889 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + +
+31. + Skip to content + +
+
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

31. 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.

+

31.1 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.
    • +
+

31.2 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 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.
    • +
+

31.3 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.
    • +
+

31.4 Pull requests

+

31.4.1 Development workflow

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

31.4.2 Development environment

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

31.4.3 Make changes

+

31.4.3.1 Checkout a branch

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

31.4.3.2 Check code style

+

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

+

31.4.3.3 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.

+

31.4.3.4 Commit

+

Follow our commit message conventions.

+

31.4.4 Yes! Pull request

+

Make your pull request, then describe your changes.

+

31.4.4.1 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'
    • +
+

31.4.4.2 Description

+

If it has related issues, add links to the issues(like #123) in the description. +Fill in the Pull Request Template by check your case.

+

31.5 Code of conduct

+

This project and everyone participating in it is governed by the Code of +Conduct. By participating, you are expected to uphold this +code. Please report unacceptable behaviour to tim@kartoza.com.

+
+

This guide is based on atom contributing +guide, +CocoaPods +and ESLint

+
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/about/disclaimer/index.html b/about/disclaimer/index.html new file mode 100644 index 0000000..e94c8e8 --- /dev/null +++ b/about/disclaimer/index.html @@ -0,0 +1,588 @@ + + + + + + + + + + + + +GeoSight-OS Documentation Home - Project Name + + + + + + + + + + + + + + +
+32. + Skip to content + +
+
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

32. Disclaimer

+ +

Disclaimer about project.

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/about/img/naming-convention.README b/about/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/about/img/naming-convention.README @@ -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 diff --git a/about/index.html b/about/index.html new file mode 100644 index 0000000..43006b2 --- /dev/null +++ b/about/index.html @@ -0,0 +1,647 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + +
+30. + Skip to content + +
+
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

30. About

+

30.1 License

+

Published under AGPL-3. See the full license text.

+

30.2 Contributors

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
ContributorGitHub Handle
Tim Suttontimlinux“”
Jeremy PriorJeremy-Prior
Ketan Bamniyaketankartoza
+

30.3 Project funders/backers

+

This project was conceptualized and initially funded by FUNDER_1.

+

30.4 Logos

+

Another fine project contributed to by: Kartoza.com +Kartoza Logo

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/about/license/index.html b/about/license/index.html new file mode 100644 index 0000000..21ad7e6 --- /dev/null +++ b/about/license/index.html @@ -0,0 +1,1620 @@ + + + + + + + + + + + + + +License - Project Name + + + + + + + + + + + + + + +
+2. + Skip to content + +
+
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

2. GNU Affero General Public License

+

Version 3, 19 November 2007 +Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/>

+

Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed.

+

2.1 Preamble

+

The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software.

+

The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users.

+

When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things.

+

Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software.

+

A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public.

+

The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version.

+

An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license.

+

The precise terms and conditions for copying, distribution and +modification follow.

+

2.2 TERMS AND CONDITIONS

+

2.2.1 0. Definitions

+

“This License” refers to version 3 of the GNU Affero General Public License.

+

“Copyright” also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks.

+

“The Program” refers to any copyrightable work licensed under this +License. Each licensee is addressed as “you”. “Licensees” and +“recipients” may be individuals or organizations.

+

To “modify” a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a “modified version” of the +earlier work or a work “based on” the earlier work.

+

A “covered work” means either the unmodified Program or a work based +on the Program.

+

To “propagate” a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well.

+

To “convey” a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying.

+

An interactive user interface displays “Appropriate Legal Notices” +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion.

+

2.2.2 1. Source Code

+

The “source code” for a work means the preferred form of the work +for making modifications to it. “Object code” means any non-source +form of a work.

+

A “Standard Interface” means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language.

+

The “System Libraries” of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +“Major Component”, in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it.

+

The “Corresponding Source” for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work.

+

The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source.

+

The Corresponding Source for a work in source code form is that +same work.

+

2.2.3 2. Basic Permissions

+

All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law.

+

You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you.

+

Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary.

+ +

No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures.

+

When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures.

+

2.2.5 4. Conveying Verbatim Copies

+

You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program.

+

You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee.

+

2.2.6 5. Conveying Modified Source Versions

+

You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions:

+
    +
  • a) The work must carry prominent notices stating that you modified +it, and giving a relevant date.
    • +
  • b) The work must carry prominent notices stating that it is +released under this License and any conditions added under section 7. +This requirement modifies the requirement in section 4 to +“keep intact all notices”.
    • +
  • c) You must license the entire work, as a whole, under this +License to anyone who comes into possession of a copy. This +License will therefore apply, along with any applicable section 7 +additional terms, to the whole of the work, and all its parts, +regardless of how they are packaged. This License gives no +permission to license the work in any other way, but it does not +invalidate such permission if you have separately received it.
    • +
  • d) If the work has interactive user interfaces, each must display +Appropriate Legal Notices; however, if the Program has interactive +interfaces that do not display Appropriate Legal Notices, your +work need not make them do so.
    • +
+

A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +“aggregate” if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate.

+

2.2.7 6. Conveying Non-Source Forms

+

You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways:

+
    +
  • a) Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by the +Corresponding Source fixed on a durable physical medium +customarily used for software interchange.
    • +
  • b) Convey the object code in, or embodied in, a physical product +(including a physical distribution medium), accompanied by a +written offer, valid for at least three years and valid for as +long as you offer spare parts or customer support for that product +model, to give anyone who possesses the object code either (1) a +copy of the Corresponding Source for all the software in the +product that is covered by this License, on a durable physical +medium customarily used for software interchange, for a price no +more than your reasonable cost of physically performing this +conveying of source, or (2) access to copy the +Corresponding Source from a network server at no charge.
    • +
  • c) Convey individual copies of the object code with a copy of the +written offer to provide the Corresponding Source. This +alternative is allowed only occasionally and noncommercially, and +only if you received the object code with such an offer, in accord +with subsection 6b.
    • +
  • d) Convey the object code by offering access from a designated +place (gratis or for a charge), and offer equivalent access to the +Corresponding Source in the same way through the same place at no +further charge. You need not require recipients to copy the +Corresponding Source along with the object code. If the place to +copy the object code is a network server, the Corresponding Source +may be on a different server (operated by you or a third party) +that supports equivalent copying facilities, provided you maintain +clear directions next to the object code saying where to find the +Corresponding Source. Regardless of what server hosts the +Corresponding Source, you remain obligated to ensure that it is +available for as long as needed to satisfy these requirements.
    • +
  • e) Convey the object code using peer-to-peer transmission, provided +you inform other peers where the object code and Corresponding +Source of the work are being offered to the general public at no +charge under subsection 6d.
    • +
+

A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work.

+

A “User Product” is either (1) a “consumer product”, which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, “normally used” refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product.

+

“Installation Information” for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made.

+

If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM).

+

The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network.

+

Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying.

+

2.2.8 7. Additional Terms

+

“Additional permissions” are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions.

+

When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission.

+

Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms:

+
    +
  • a) Disclaiming warranty or limiting liability differently from the +terms of sections 15 and 16 of this License; or
    • +
  • b) Requiring preservation of specified reasonable legal notices or +author attributions in that material or in the Appropriate Legal +Notices displayed by works containing it; or
    • +
  • c) Prohibiting misrepresentation of the origin of that material, or +requiring that modified versions of such material be marked in +reasonable ways as different from the original version; or
    • +
  • d) Limiting the use for publicity purposes of names of licensors or +authors of the material; or
    • +
  • e) Declining to grant rights under trademark law for use of some +trade names, trademarks, or service marks; or
    • +
  • f) Requiring indemnification of licensors and authors of that +material by anyone who conveys the material (or modified versions of +it) with contractual assumptions of liability to the recipient, for +any liability that these contractual assumptions directly impose on +those licensors and authors.
    • +
+

All other non-permissive additional terms are considered “further +restrictions” within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying.

+

If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms.

+

Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way.

+

2.2.9 8. Termination

+

You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11).

+

However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation.

+

Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice.

+

Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10.

+

2.2.10 9. Acceptance Not Required for Having Copies

+

You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so.

+

2.2.11 10. Automatic Licensing of Downstream Recipients

+

Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License.

+

An “entity transaction” is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts.

+

You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it.

+

2.2.12 11. Patents

+

A “contributor” is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's “contributor version”.

+

A contributor's “essential patent claims” are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, “control” includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License.

+

Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version.

+

In the following three paragraphs, a “patent license” is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To “grant” such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party.

+

If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. “Knowingly relying” means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid.

+

If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it.

+

A patent license is “discriminatory” if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007.

+

Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law.

+

2.2.13 12. No Surrender of Others' Freedom

+

If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program.

+

2.2.14 13. Remote Network Interaction; Use with the GNU General Public License

+

Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph.

+

Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License.

+

2.2.15 14. Revised Versions of this License

+

The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns.

+

Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License “or any later version” applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation.

+

If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program.

+

Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version.

+

2.2.16 15. Disclaimer of Warranty

+

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

+

2.2.17 16. Limitation of Liability

+

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES.

+

2.2.18 17. Interpretation of Sections 15 and 16

+

If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee.

+

END OF TERMS AND CONDITIONS

+

2.3 How to Apply These Terms to Your New Programs

+

If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms.

+

To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the “copyright” line and a pointer to where the full notice is found.

+
<one line to give the program's name and a brief idea of what it does.>
+Copyright (C) <year>  <name of author>
+
+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.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+

Also add information on how to contact you by electronic and paper mail.

+

If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a “Source” link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements.

+

You should also get your employer (if you work as a programmer) or school, +if any, to sign a “copyright disclaimer” for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<http://www.gnu.org/licenses/>.

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/about/running-instances/index.html b/about/running-instances/index.html new file mode 100644 index 0000000..39192e2 --- /dev/null +++ b/about/running-instances/index.html @@ -0,0 +1,587 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + +
+3. + Skip to content + +
+
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

3. Examples of running instances

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/administrator/guide/img/naming-convention.README b/administrator/guide/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/administrator/guide/img/naming-convention.README @@ -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 diff --git a/administrator/guide/index.html b/administrator/guide/index.html new file mode 100644 index 0000000..79b8bed --- /dev/null +++ b/administrator/guide/index.html @@ -0,0 +1,588 @@ + + + + + + + + + + + + + +PROJECT_TITLE - Project Name + + + + + + + + + + + + + + +
+7. + Skip to content + +
+
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

7. Administrator guide

+ +
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/administrator/img/naming-convention.README b/administrator/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/administrator/img/naming-convention.README @@ -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 diff --git a/administrator/index.html b/administrator/index.html new file mode 100644 index 0000000..4236d25 --- /dev/null +++ b/administrator/index.html @@ -0,0 +1,1582 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

For administrators

+ + +

This is the homepage for all administrator related documentation.

+

The content is divided into two sections:

+
    +
  • The user guide, which describes common workflows for system administrators in a tutorial format.
    • +
  • The user manual, which describes each page of the admin user interface and what the various options on that page do.
    • +
+ + + + + + +
+
+ + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/administrator/manual/img/naming-convention.README b/administrator/manual/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/administrator/manual/img/naming-convention.README @@ -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 diff --git a/administrator/manual/index.html b/administrator/manual/index.html new file mode 100644 index 0000000..1f717d5 --- /dev/null +++ b/administrator/manual/index.html @@ -0,0 +1,587 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + +
+8. + Skip to content + +
+
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

8. Administrator manual

+
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/assets/_mkdocstrings.css b/assets/_mkdocstrings.css new file mode 100644 index 0000000..85449ec --- /dev/null +++ b/assets/_mkdocstrings.css @@ -0,0 +1,119 @@ + +/* Avoid breaking parameter names, etc. in table cells. */ +.doc-contents td code { + word-break: normal !important; +} + +/* No line break before first paragraph of descriptions. */ +.doc-md-description, +.doc-md-description>p:first-child { + display: inline; +} + +/* Max width for docstring sections tables. */ +.doc .md-typeset__table, +.doc .md-typeset__table table { + display: table !important; + width: 100%; +} + +.doc .md-typeset__table tr { + display: table-row; +} + +/* Defaults in Spacy table style. */ +.doc-param-default { + float: right; +} + +/* Backward-compatibility: docstring section titles in bold. */ +.doc-section-title { + font-weight: bold; +} + +/* Symbols in Navigation and ToC. */ +:root, +[data-md-color-scheme="default"] { + --doc-symbol-attribute-fg-color: #953800; + --doc-symbol-function-fg-color: #8250df; + --doc-symbol-method-fg-color: #8250df; + --doc-symbol-class-fg-color: #0550ae; + --doc-symbol-module-fg-color: #5cad0f; + + --doc-symbol-attribute-bg-color: #9538001a; + --doc-symbol-function-bg-color: #8250df1a; + --doc-symbol-method-bg-color: #8250df1a; + --doc-symbol-class-bg-color: #0550ae1a; + --doc-symbol-module-bg-color: #5cad0f1a; +} + +[data-md-color-scheme="slate"] { + --doc-symbol-attribute-fg-color: #ffa657; + --doc-symbol-function-fg-color: #d2a8ff; + --doc-symbol-method-fg-color: #d2a8ff; + --doc-symbol-class-fg-color: #79c0ff; + --doc-symbol-module-fg-color: #baff79; + + --doc-symbol-attribute-bg-color: #ffa6571a; + --doc-symbol-function-bg-color: #d2a8ff1a; + --doc-symbol-method-bg-color: #d2a8ff1a; + --doc-symbol-class-bg-color: #79c0ff1a; + --doc-symbol-module-bg-color: #baff791a; +} + +code.doc-symbol { + border-radius: .1rem; + font-size: .85em; + padding: 0 .3em; + font-weight: bold; +} + +code.doc-symbol-attribute { + color: var(--doc-symbol-attribute-fg-color); + background-color: var(--doc-symbol-attribute-bg-color); +} + +code.doc-symbol-attribute::after { + content: "attr"; +} + +code.doc-symbol-function { + color: var(--doc-symbol-function-fg-color); + background-color: var(--doc-symbol-function-bg-color); +} + +code.doc-symbol-function::after { + content: "func"; +} + +code.doc-symbol-method { + color: var(--doc-symbol-method-fg-color); + background-color: var(--doc-symbol-method-bg-color); +} + +code.doc-symbol-method::after { + content: "meth"; +} + +code.doc-symbol-class { + color: var(--doc-symbol-class-fg-color); + background-color: var(--doc-symbol-class-bg-color); +} + +code.doc-symbol-class::after { + content: "class"; +} + +code.doc-symbol-module { + color: var(--doc-symbol-module-fg-color); + background-color: var(--doc-symbol-module-bg-color); +} + +code.doc-symbol-module::after { + content: "mod"; +} + +.doc-signature .autorefs { + color: inherit; + border-bottom: 1px dotted currentcolor; +} diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 0000000..1cf13b9 Binary files /dev/null and b/assets/images/favicon.png differ diff --git a/assets/javascripts/bundle.51d95adb.min.js b/assets/javascripts/bundle.51d95adb.min.js new file mode 100644 index 0000000..b20ec68 --- /dev/null +++ b/assets/javascripts/bundle.51d95adb.min.js @@ -0,0 +1,29 @@ +"use strict";(()=>{var Hi=Object.create;var xr=Object.defineProperty;var Pi=Object.getOwnPropertyDescriptor;var $i=Object.getOwnPropertyNames,kt=Object.getOwnPropertySymbols,Ii=Object.getPrototypeOf,Er=Object.prototype.hasOwnProperty,an=Object.prototype.propertyIsEnumerable;var on=(e,t,r)=>t in e?xr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,P=(e,t)=>{for(var r in t||(t={}))Er.call(t,r)&&on(e,r,t[r]);if(kt)for(var r of kt(t))an.call(t,r)&&on(e,r,t[r]);return e};var sn=(e,t)=>{var r={};for(var n in e)Er.call(e,n)&&t.indexOf(n)<0&&(r[n]=e[n]);if(e!=null&&kt)for(var n of kt(e))t.indexOf(n)<0&&an.call(e,n)&&(r[n]=e[n]);return r};var Ht=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Fi=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of $i(t))!Er.call(e,o)&&o!==r&&xr(e,o,{get:()=>t[o],enumerable:!(n=Pi(t,o))||n.enumerable});return e};var yt=(e,t,r)=>(r=e!=null?Hi(Ii(e)):{},Fi(t||!e||!e.__esModule?xr(r,"default",{value:e,enumerable:!0}):r,e));var fn=Ht((wr,cn)=>{(function(e,t){typeof wr=="object"&&typeof cn!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(wr,function(){"use strict";function e(r){var n=!0,o=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(T){return!!(T&&T!==document&&T.nodeName!=="HTML"&&T.nodeName!=="BODY"&&"classList"in T&&"contains"in T.classList)}function f(T){var Ke=T.type,We=T.tagName;return!!(We==="INPUT"&&a[Ke]&&!T.readOnly||We==="TEXTAREA"&&!T.readOnly||T.isContentEditable)}function c(T){T.classList.contains("focus-visible")||(T.classList.add("focus-visible"),T.setAttribute("data-focus-visible-added",""))}function u(T){T.hasAttribute("data-focus-visible-added")&&(T.classList.remove("focus-visible"),T.removeAttribute("data-focus-visible-added"))}function p(T){T.metaKey||T.altKey||T.ctrlKey||(s(r.activeElement)&&c(r.activeElement),n=!0)}function m(T){n=!1}function d(T){s(T.target)&&(n||f(T.target))&&c(T.target)}function h(T){s(T.target)&&(T.target.classList.contains("focus-visible")||T.target.hasAttribute("data-focus-visible-added"))&&(o=!0,window.clearTimeout(i),i=window.setTimeout(function(){o=!1},100),u(T.target))}function v(T){document.visibilityState==="hidden"&&(o&&(n=!0),B())}function B(){document.addEventListener("mousemove",z),document.addEventListener("mousedown",z),document.addEventListener("mouseup",z),document.addEventListener("pointermove",z),document.addEventListener("pointerdown",z),document.addEventListener("pointerup",z),document.addEventListener("touchmove",z),document.addEventListener("touchstart",z),document.addEventListener("touchend",z)}function re(){document.removeEventListener("mousemove",z),document.removeEventListener("mousedown",z),document.removeEventListener("mouseup",z),document.removeEventListener("pointermove",z),document.removeEventListener("pointerdown",z),document.removeEventListener("pointerup",z),document.removeEventListener("touchmove",z),document.removeEventListener("touchstart",z),document.removeEventListener("touchend",z)}function z(T){T.target.nodeName&&T.target.nodeName.toLowerCase()==="html"||(n=!1,re())}document.addEventListener("keydown",p,!0),document.addEventListener("mousedown",m,!0),document.addEventListener("pointerdown",m,!0),document.addEventListener("touchstart",m,!0),document.addEventListener("visibilitychange",v,!0),B(),r.addEventListener("focus",d,!0),r.addEventListener("blur",h,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var un=Ht(Sr=>{(function(e){var t=function(){try{return!!Symbol.iterator}catch(c){return!1}},r=t(),n=function(c){var u={next:function(){var p=c.shift();return{done:p===void 0,value:p}}};return r&&(u[Symbol.iterator]=function(){return u}),u},o=function(c){return encodeURIComponent(c).replace(/%20/g,"+")},i=function(c){return decodeURIComponent(String(c).replace(/\+/g," "))},a=function(){var c=function(p){Object.defineProperty(this,"_entries",{writable:!0,value:{}});var m=typeof p;if(m!=="undefined")if(m==="string")p!==""&&this._fromString(p);else if(p instanceof c){var d=this;p.forEach(function(re,z){d.append(z,re)})}else if(p!==null&&m==="object")if(Object.prototype.toString.call(p)==="[object Array]")for(var h=0;hd[0]?1:0}),c._entries&&(c._entries={});for(var p=0;p1?i(d[1]):"")}})})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Sr);(function(e){var t=function(){try{var o=new e.URL("b","http://a");return o.pathname="c d",o.href==="http://a/c%20d"&&o.searchParams}catch(i){return!1}},r=function(){var o=e.URL,i=function(f,c){typeof f!="string"&&(f=String(f)),c&&typeof c!="string"&&(c=String(c));var u=document,p;if(c&&(e.location===void 0||c!==e.location.href)){c=c.toLowerCase(),u=document.implementation.createHTMLDocument(""),p=u.createElement("base"),p.href=c,u.head.appendChild(p);try{if(p.href.indexOf(c)!==0)throw new Error(p.href)}catch(T){throw new Error("URL unable to set base "+c+" due to "+T)}}var m=u.createElement("a");m.href=f,p&&(u.body.appendChild(m),m.href=m.href);var d=u.createElement("input");if(d.type="url",d.value=f,m.protocol===":"||!/:/.test(m.href)||!d.checkValidity()&&!c)throw new TypeError("Invalid URL");Object.defineProperty(this,"_anchorElement",{value:m});var h=new e.URLSearchParams(this.search),v=!0,B=!0,re=this;["append","delete","set"].forEach(function(T){var Ke=h[T];h[T]=function(){Ke.apply(h,arguments),v&&(B=!1,re.search=h.toString(),B=!0)}}),Object.defineProperty(this,"searchParams",{value:h,enumerable:!0});var z=void 0;Object.defineProperty(this,"_updateSearchParams",{enumerable:!1,configurable:!1,writable:!1,value:function(){this.search!==z&&(z=this.search,B&&(v=!1,this.searchParams._fromString(this.search),v=!0))}})},a=i.prototype,s=function(f){Object.defineProperty(a,f,{get:function(){return this._anchorElement[f]},set:function(c){this._anchorElement[f]=c},enumerable:!0})};["hash","host","hostname","port","protocol"].forEach(function(f){s(f)}),Object.defineProperty(a,"search",{get:function(){return this._anchorElement.search},set:function(f){this._anchorElement.search=f,this._updateSearchParams()},enumerable:!0}),Object.defineProperties(a,{toString:{get:function(){var f=this;return function(){return f.href}}},href:{get:function(){return this._anchorElement.href.replace(/\?$/,"")},set:function(f){this._anchorElement.href=f,this._updateSearchParams()},enumerable:!0},pathname:{get:function(){return this._anchorElement.pathname.replace(/(^\/?)/,"/")},set:function(f){this._anchorElement.pathname=f},enumerable:!0},origin:{get:function(){var f={"http:":80,"https:":443,"ftp:":21}[this._anchorElement.protocol],c=this._anchorElement.port!=f&&this._anchorElement.port!=="";return this._anchorElement.protocol+"//"+this._anchorElement.hostname+(c?":"+this._anchorElement.port:"")},enumerable:!0},password:{get:function(){return""},set:function(f){},enumerable:!0},username:{get:function(){return""},set:function(f){},enumerable:!0}}),i.createObjectURL=function(f){return o.createObjectURL.apply(o,arguments)},i.revokeObjectURL=function(f){return o.revokeObjectURL.apply(o,arguments)},e.URL=i};if(t()||r(),e.location!==void 0&&!("origin"in e.location)){var n=function(){return e.location.protocol+"//"+e.location.hostname+(e.location.port?":"+e.location.port:"")};try{Object.defineProperty(e.location,"origin",{get:n,enumerable:!0})}catch(o){setInterval(function(){e.location.origin=n()},100)}}})(typeof global!="undefined"?global:typeof window!="undefined"?window:typeof self!="undefined"?self:Sr)});var Qr=Ht((Lt,Kr)=>{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Lt=="object"&&typeof Kr=="object"?Kr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Lt=="object"?Lt.ClipboardJS=r():t.ClipboardJS=r()})(Lt,function(){return function(){var e={686:function(n,o,i){"use strict";i.d(o,{default:function(){return ki}});var a=i(279),s=i.n(a),f=i(370),c=i.n(f),u=i(817),p=i.n(u);function m(j){try{return document.execCommand(j)}catch(O){return!1}}var d=function(O){var w=p()(O);return m("cut"),w},h=d;function v(j){var O=document.documentElement.getAttribute("dir")==="rtl",w=document.createElement("textarea");w.style.fontSize="12pt",w.style.border="0",w.style.padding="0",w.style.margin="0",w.style.position="absolute",w.style[O?"right":"left"]="-9999px";var k=window.pageYOffset||document.documentElement.scrollTop;return w.style.top="".concat(k,"px"),w.setAttribute("readonly",""),w.value=j,w}var B=function(O,w){var k=v(O);w.container.appendChild(k);var F=p()(k);return m("copy"),k.remove(),F},re=function(O){var w=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},k="";return typeof O=="string"?k=B(O,w):O instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(O==null?void 0:O.type)?k=B(O.value,w):(k=p()(O),m("copy")),k},z=re;function T(j){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?T=function(w){return typeof w}:T=function(w){return w&&typeof Symbol=="function"&&w.constructor===Symbol&&w!==Symbol.prototype?"symbol":typeof w},T(j)}var Ke=function(){var O=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},w=O.action,k=w===void 0?"copy":w,F=O.container,q=O.target,Le=O.text;if(k!=="copy"&&k!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(q!==void 0)if(q&&T(q)==="object"&&q.nodeType===1){if(k==="copy"&&q.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(k==="cut"&&(q.hasAttribute("readonly")||q.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(Le)return z(Le,{container:F});if(q)return k==="cut"?h(q):z(q,{container:F})},We=Ke;function Ie(j){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Ie=function(w){return typeof w}:Ie=function(w){return w&&typeof Symbol=="function"&&w.constructor===Symbol&&w!==Symbol.prototype?"symbol":typeof w},Ie(j)}function Ti(j,O){if(!(j instanceof O))throw new TypeError("Cannot call a class as a function")}function nn(j,O){for(var w=0;w0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof F.action=="function"?F.action:this.defaultAction,this.target=typeof F.target=="function"?F.target:this.defaultTarget,this.text=typeof F.text=="function"?F.text:this.defaultText,this.container=Ie(F.container)==="object"?F.container:document.body}},{key:"listenClick",value:function(F){var q=this;this.listener=c()(F,"click",function(Le){return q.onClick(Le)})}},{key:"onClick",value:function(F){var q=F.delegateTarget||F.currentTarget,Le=this.action(q)||"copy",Rt=We({action:Le,container:this.container,target:this.target(q),text:this.text(q)});this.emit(Rt?"success":"error",{action:Le,text:Rt,trigger:q,clearSelection:function(){q&&q.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(F){return yr("action",F)}},{key:"defaultTarget",value:function(F){var q=yr("target",F);if(q)return document.querySelector(q)}},{key:"defaultText",value:function(F){return yr("text",F)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(F){var q=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return z(F,q)}},{key:"cut",value:function(F){return h(F)}},{key:"isSupported",value:function(){var F=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],q=typeof F=="string"?[F]:F,Le=!!document.queryCommandSupported;return q.forEach(function(Rt){Le=Le&&!!document.queryCommandSupported(Rt)}),Le}}]),w}(s()),ki=Ri},828:function(n){var o=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,f){for(;s&&s.nodeType!==o;){if(typeof s.matches=="function"&&s.matches(f))return s;s=s.parentNode}}n.exports=a},438:function(n,o,i){var a=i(828);function s(u,p,m,d,h){var v=c.apply(this,arguments);return u.addEventListener(m,v,h),{destroy:function(){u.removeEventListener(m,v,h)}}}function f(u,p,m,d,h){return typeof u.addEventListener=="function"?s.apply(null,arguments):typeof m=="function"?s.bind(null,document).apply(null,arguments):(typeof u=="string"&&(u=document.querySelectorAll(u)),Array.prototype.map.call(u,function(v){return s(v,p,m,d,h)}))}function c(u,p,m,d){return function(h){h.delegateTarget=a(h.target,p),h.delegateTarget&&d.call(u,h)}}n.exports=f},879:function(n,o){o.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},o.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||o.node(i[0]))},o.string=function(i){return typeof i=="string"||i instanceof String},o.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(n,o,i){var a=i(879),s=i(438);function f(m,d,h){if(!m&&!d&&!h)throw new Error("Missing required arguments");if(!a.string(d))throw new TypeError("Second argument must be a String");if(!a.fn(h))throw new TypeError("Third argument must be a Function");if(a.node(m))return c(m,d,h);if(a.nodeList(m))return u(m,d,h);if(a.string(m))return p(m,d,h);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(m,d,h){return m.addEventListener(d,h),{destroy:function(){m.removeEventListener(d,h)}}}function u(m,d,h){return Array.prototype.forEach.call(m,function(v){v.addEventListener(d,h)}),{destroy:function(){Array.prototype.forEach.call(m,function(v){v.removeEventListener(d,h)})}}}function p(m,d,h){return s(document.body,m,d,h)}n.exports=f},817:function(n){function o(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var f=window.getSelection(),c=document.createRange();c.selectNodeContents(i),f.removeAllRanges(),f.addRange(c),a=f.toString()}return a}n.exports=o},279:function(n){function o(){}o.prototype={on:function(i,a,s){var f=this.e||(this.e={});return(f[i]||(f[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var f=this;function c(){f.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),f=0,c=s.length;for(f;f{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var is=/["'&<>]/;Jo.exports=as;function as(e){var t=""+e,r=is.exec(t);if(!r)return t;var n,o="",i=0,a=0;for(i=r.index;i0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[n++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function W(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var n=r.call(e),o,i=[],a;try{for(;(t===void 0||t-- >0)&&!(o=n.next()).done;)i.push(o.value)}catch(s){a={error:s}}finally{try{o&&!o.done&&(r=n.return)&&r.call(n)}finally{if(a)throw a.error}}return i}function D(e,t,r){if(r||arguments.length===2)for(var n=0,o=t.length,i;n1||s(m,d)})})}function s(m,d){try{f(n[m](d))}catch(h){p(i[0][3],h)}}function f(m){m.value instanceof Xe?Promise.resolve(m.value.v).then(c,u):p(i[0][2],m)}function c(m){s("next",m)}function u(m){s("throw",m)}function p(m,d){m(d),i.shift(),i.length&&s(i[0][0],i[0][1])}}function mn(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof xe=="function"?xe(e):e[Symbol.iterator](),r={},n("next"),n("throw"),n("return"),r[Symbol.asyncIterator]=function(){return this},r);function n(i){r[i]=e[i]&&function(a){return new Promise(function(s,f){a=e[i](a),o(s,f,a.done,a.value)})}}function o(i,a,s,f){Promise.resolve(f).then(function(c){i({value:c,done:s})},a)}}function A(e){return typeof e=="function"}function at(e){var t=function(n){Error.call(n),n.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var $t=at(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(n,o){return o+1+") "+n.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function De(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Fe=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,n,o,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=xe(a),f=s.next();!f.done;f=s.next()){var c=f.value;c.remove(this)}}catch(v){t={error:v}}finally{try{f&&!f.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var u=this.initialTeardown;if(A(u))try{u()}catch(v){i=v instanceof $t?v.errors:[v]}var p=this._finalizers;if(p){this._finalizers=null;try{for(var m=xe(p),d=m.next();!d.done;d=m.next()){var h=d.value;try{dn(h)}catch(v){i=i!=null?i:[],v instanceof $t?i=D(D([],W(i)),W(v.errors)):i.push(v)}}}catch(v){n={error:v}}finally{try{d&&!d.done&&(o=m.return)&&o.call(m)}finally{if(n)throw n.error}}}if(i)throw new $t(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)dn(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&De(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&De(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Or=Fe.EMPTY;function It(e){return e instanceof Fe||e&&"closed"in e&&A(e.remove)&&A(e.add)&&A(e.unsubscribe)}function dn(e){A(e)?e():e.unsubscribe()}var Ae={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var st={setTimeout:function(e,t){for(var r=[],n=2;n0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var n=this,o=this,i=o.hasError,a=o.isStopped,s=o.observers;return i||a?Or:(this.currentObservers=null,s.push(r),new Fe(function(){n.currentObservers=null,De(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var n=this,o=n.hasError,i=n.thrownError,a=n.isStopped;o?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new U;return r.source=this,r},t.create=function(r,n){return new wn(r,n)},t}(U);var wn=function(e){ne(t,e);function t(r,n){var o=e.call(this)||this;return o.destination=r,o.source=n,o}return t.prototype.next=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.next)===null||o===void 0||o.call(n,r)},t.prototype.error=function(r){var n,o;(o=(n=this.destination)===null||n===void 0?void 0:n.error)===null||o===void 0||o.call(n,r)},t.prototype.complete=function(){var r,n;(n=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||n===void 0||n.call(r)},t.prototype._subscribe=function(r){var n,o;return(o=(n=this.source)===null||n===void 0?void 0:n.subscribe(r))!==null&&o!==void 0?o:Or},t}(E);var Et={now:function(){return(Et.delegate||Date).now()},delegate:void 0};var wt=function(e){ne(t,e);function t(r,n,o){r===void 0&&(r=1/0),n===void 0&&(n=1/0),o===void 0&&(o=Et);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=n,i._timestampProvider=o,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=n===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,n),i}return t.prototype.next=function(r){var n=this,o=n.isStopped,i=n._buffer,a=n._infiniteTimeWindow,s=n._timestampProvider,f=n._windowTime;o||(i.push(r),!a&&i.push(s.now()+f)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var n=this._innerSubscribe(r),o=this,i=o._infiniteTimeWindow,a=o._buffer,s=a.slice(),f=0;f0?e.prototype.requestAsyncId.call(this,r,n,o):(r.actions.push(this),r._scheduled||(r._scheduled=ut.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,n,o){var i;if(o===void 0&&(o=0),o!=null?o>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,n,o);var a=r.actions;n!=null&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==n&&(ut.cancelAnimationFrame(n),r._scheduled=void 0)},t}(Ut);var On=function(e){ne(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var n=this._scheduled;this._scheduled=void 0;var o=this.actions,i;r=r||o.shift();do if(i=r.execute(r.state,r.delay))break;while((r=o[0])&&r.id===n&&o.shift());if(this._active=!1,i){for(;(r=o[0])&&r.id===n&&o.shift();)r.unsubscribe();throw i}},t}(Wt);var we=new On(Tn);var R=new U(function(e){return e.complete()});function Dt(e){return e&&A(e.schedule)}function kr(e){return e[e.length-1]}function Qe(e){return A(kr(e))?e.pop():void 0}function Se(e){return Dt(kr(e))?e.pop():void 0}function Vt(e,t){return typeof kr(e)=="number"?e.pop():t}var pt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function zt(e){return A(e==null?void 0:e.then)}function Nt(e){return A(e[ft])}function qt(e){return Symbol.asyncIterator&&A(e==null?void 0:e[Symbol.asyncIterator])}function Kt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Ki(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var Qt=Ki();function Yt(e){return A(e==null?void 0:e[Qt])}function Gt(e){return ln(this,arguments,function(){var r,n,o,i;return Pt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,Xe(r.read())];case 3:return n=a.sent(),o=n.value,i=n.done,i?[4,Xe(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,Xe(o)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function Bt(e){return A(e==null?void 0:e.getReader)}function $(e){if(e instanceof U)return e;if(e!=null){if(Nt(e))return Qi(e);if(pt(e))return Yi(e);if(zt(e))return Gi(e);if(qt(e))return _n(e);if(Yt(e))return Bi(e);if(Bt(e))return Ji(e)}throw Kt(e)}function Qi(e){return new U(function(t){var r=e[ft]();if(A(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Yi(e){return new U(function(t){for(var r=0;r=2;return function(n){return n.pipe(e?_(function(o,i){return e(o,i,n)}):me,Oe(1),r?He(t):zn(function(){return new Xt}))}}function Nn(){for(var e=[],t=0;t=2,!0))}function fe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new E}:t,n=e.resetOnError,o=n===void 0?!0:n,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,f=s===void 0?!0:s;return function(c){var u,p,m,d=0,h=!1,v=!1,B=function(){p==null||p.unsubscribe(),p=void 0},re=function(){B(),u=m=void 0,h=v=!1},z=function(){var T=u;re(),T==null||T.unsubscribe()};return g(function(T,Ke){d++,!v&&!h&&B();var We=m=m!=null?m:r();Ke.add(function(){d--,d===0&&!v&&!h&&(p=jr(z,f))}),We.subscribe(Ke),!u&&d>0&&(u=new et({next:function(Ie){return We.next(Ie)},error:function(Ie){v=!0,B(),p=jr(re,o,Ie),We.error(Ie)},complete:function(){h=!0,B(),p=jr(re,a),We.complete()}}),$(T).subscribe(u))})(c)}}function jr(e,t){for(var r=[],n=2;ne.next(document)),e}function K(e,t=document){return Array.from(t.querySelectorAll(e))}function V(e,t=document){let r=se(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function se(e,t=document){return t.querySelector(e)||void 0}function _e(){return document.activeElement instanceof HTMLElement&&document.activeElement||void 0}function tr(e){return L(b(document.body,"focusin"),b(document.body,"focusout")).pipe(ke(1),l(()=>{let t=_e();return typeof t!="undefined"?e.contains(t):!1}),N(e===_e()),Y())}function Be(e){return{x:e.offsetLeft,y:e.offsetTop}}function Yn(e){return L(b(window,"load"),b(window,"resize")).pipe(Ce(0,we),l(()=>Be(e)),N(Be(e)))}function rr(e){return{x:e.scrollLeft,y:e.scrollTop}}function dt(e){return L(b(e,"scroll"),b(window,"resize")).pipe(Ce(0,we),l(()=>rr(e)),N(rr(e)))}var Bn=function(){if(typeof Map!="undefined")return Map;function e(t,r){var n=-1;return t.some(function(o,i){return o[0]===r?(n=i,!0):!1}),n}return function(){function t(){this.__entries__=[]}return Object.defineProperty(t.prototype,"size",{get:function(){return this.__entries__.length},enumerable:!0,configurable:!0}),t.prototype.get=function(r){var n=e(this.__entries__,r),o=this.__entries__[n];return o&&o[1]},t.prototype.set=function(r,n){var o=e(this.__entries__,r);~o?this.__entries__[o][1]=n:this.__entries__.push([r,n])},t.prototype.delete=function(r){var n=this.__entries__,o=e(n,r);~o&&n.splice(o,1)},t.prototype.has=function(r){return!!~e(this.__entries__,r)},t.prototype.clear=function(){this.__entries__.splice(0)},t.prototype.forEach=function(r,n){n===void 0&&(n=null);for(var o=0,i=this.__entries__;o0},e.prototype.connect_=function(){!zr||this.connected_||(document.addEventListener("transitionend",this.onTransitionEnd_),window.addEventListener("resize",this.refresh),xa?(this.mutationsObserver_=new MutationObserver(this.refresh),this.mutationsObserver_.observe(document,{attributes:!0,childList:!0,characterData:!0,subtree:!0})):(document.addEventListener("DOMSubtreeModified",this.refresh),this.mutationEventsAdded_=!0),this.connected_=!0)},e.prototype.disconnect_=function(){!zr||!this.connected_||(document.removeEventListener("transitionend",this.onTransitionEnd_),window.removeEventListener("resize",this.refresh),this.mutationsObserver_&&this.mutationsObserver_.disconnect(),this.mutationEventsAdded_&&document.removeEventListener("DOMSubtreeModified",this.refresh),this.mutationsObserver_=null,this.mutationEventsAdded_=!1,this.connected_=!1)},e.prototype.onTransitionEnd_=function(t){var r=t.propertyName,n=r===void 0?"":r,o=ya.some(function(i){return!!~n.indexOf(i)});o&&this.refresh()},e.getInstance=function(){return this.instance_||(this.instance_=new e),this.instance_},e.instance_=null,e}(),Jn=function(e,t){for(var r=0,n=Object.keys(t);r0},e}(),Zn=typeof WeakMap!="undefined"?new WeakMap:new Bn,eo=function(){function e(t){if(!(this instanceof e))throw new TypeError("Cannot call a class as a function.");if(!arguments.length)throw new TypeError("1 argument required, but only 0 present.");var r=Ea.getInstance(),n=new Ra(t,r,this);Zn.set(this,n)}return e}();["observe","unobserve","disconnect"].forEach(function(e){eo.prototype[e]=function(){var t;return(t=Zn.get(this))[e].apply(t,arguments)}});var ka=function(){return typeof nr.ResizeObserver!="undefined"?nr.ResizeObserver:eo}(),to=ka;var ro=new E,Ha=I(()=>H(new to(e=>{for(let t of e)ro.next(t)}))).pipe(x(e=>L(Te,H(e)).pipe(C(()=>e.disconnect()))),J(1));function de(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){return Ha.pipe(S(t=>t.observe(e)),x(t=>ro.pipe(_(({target:r})=>r===e),C(()=>t.unobserve(e)),l(()=>de(e)))),N(de(e)))}function bt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function ar(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}var no=new E,Pa=I(()=>H(new IntersectionObserver(e=>{for(let t of e)no.next(t)},{threshold:0}))).pipe(x(e=>L(Te,H(e)).pipe(C(()=>e.disconnect()))),J(1));function sr(e){return Pa.pipe(S(t=>t.observe(e)),x(t=>no.pipe(_(({target:r})=>r===e),C(()=>t.unobserve(e)),l(({isIntersecting:r})=>r))))}function oo(e,t=16){return dt(e).pipe(l(({y:r})=>{let n=de(e),o=bt(e);return r>=o.height-n.height-t}),Y())}var cr={drawer:V("[data-md-toggle=drawer]"),search:V("[data-md-toggle=search]")};function io(e){return cr[e].checked}function qe(e,t){cr[e].checked!==t&&cr[e].click()}function je(e){let t=cr[e];return b(t,"change").pipe(l(()=>t.checked),N(t.checked))}function $a(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ia(){return L(b(window,"compositionstart").pipe(l(()=>!0)),b(window,"compositionend").pipe(l(()=>!1))).pipe(N(!1))}function ao(){let e=b(window,"keydown").pipe(_(t=>!(t.metaKey||t.ctrlKey)),l(t=>({mode:io("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),_(({mode:t,type:r})=>{if(t==="global"){let n=_e();if(typeof n!="undefined")return!$a(n,r)}return!0}),fe());return Ia().pipe(x(t=>t?R:e))}function Me(){return new URL(location.href)}function ot(e){location.href=e.href}function so(){return new E}function co(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)co(e,r)}function M(e,t,...r){let n=document.createElement(e);if(t)for(let o of Object.keys(t))typeof t[o]!="undefined"&&(typeof t[o]!="boolean"?n.setAttribute(o,t[o]):n.setAttribute(o,""));for(let o of r)co(n,o);return n}function fr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function fo(){return location.hash.substring(1)}function uo(e){let t=M("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Fa(){return b(window,"hashchange").pipe(l(fo),N(fo()),_(e=>e.length>0),J(1))}function po(){return Fa().pipe(l(e=>se(`[id="${e}"]`)),_(e=>typeof e!="undefined"))}function Nr(e){let t=matchMedia(e);return Zt(r=>t.addListener(()=>r(t.matches))).pipe(N(t.matches))}function lo(){let e=matchMedia("print");return L(b(window,"beforeprint").pipe(l(()=>!0)),b(window,"afterprint").pipe(l(()=>!1))).pipe(N(e.matches))}function qr(e,t){return e.pipe(x(r=>r?t():R))}function ur(e,t={credentials:"same-origin"}){return ve(fetch(`${e}`,t)).pipe(ce(()=>R),x(r=>r.status!==200?Tt(()=>new Error(r.statusText)):H(r)))}function Ue(e,t){return ur(e,t).pipe(x(r=>r.json()),J(1))}function mo(e,t){let r=new DOMParser;return ur(e,t).pipe(x(n=>n.text()),l(n=>r.parseFromString(n,"text/xml")),J(1))}function pr(e){let t=M("script",{src:e});return I(()=>(document.head.appendChild(t),L(b(t,"load"),b(t,"error").pipe(x(()=>Tt(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(l(()=>{}),C(()=>document.head.removeChild(t)),Oe(1))))}function ho(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function bo(){return L(b(window,"scroll",{passive:!0}),b(window,"resize",{passive:!0})).pipe(l(ho),N(ho()))}function vo(){return{width:innerWidth,height:innerHeight}}function go(){return b(window,"resize",{passive:!0}).pipe(l(vo),N(vo()))}function yo(){return Q([bo(),go()]).pipe(l(([e,t])=>({offset:e,size:t})),J(1))}function lr(e,{viewport$:t,header$:r}){let n=t.pipe(X("size")),o=Q([n,r]).pipe(l(()=>Be(e)));return Q([r,t,o]).pipe(l(([{height:i},{offset:a,size:s},{x:f,y:c}])=>({offset:{x:a.x-f,y:a.y-c+i},size:s})))}(()=>{function e(n,o){parent.postMessage(n,o||"*")}function t(...n){return n.reduce((o,i)=>o.then(()=>new Promise(a=>{let s=document.createElement("script");s.src=i,s.onload=a,document.body.appendChild(s)})),Promise.resolve())}var r=class{constructor(n){this.url=n,this.onerror=null,this.onmessage=null,this.onmessageerror=null,this.m=a=>{a.source===this.w&&(a.stopImmediatePropagation(),this.dispatchEvent(new MessageEvent("message",{data:a.data})),this.onmessage&&this.onmessage(a))},this.e=(a,s,f,c,u)=>{if(s===this.url.toString()){let p=new ErrorEvent("error",{message:a,filename:s,lineno:f,colno:c,error:u});this.dispatchEvent(p),this.onerror&&this.onerror(p)}};let o=new EventTarget;this.addEventListener=o.addEventListener.bind(o),this.removeEventListener=o.removeEventListener.bind(o),this.dispatchEvent=o.dispatchEvent.bind(o);let i=document.createElement("iframe");i.width=i.height=i.frameBorder="0",document.body.appendChild(this.iframe=i),this.w.document.open(),this.w.document.write(` + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

27. API guide

+
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/api/img/naming-convention.README b/developer/api/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/developer/api/img/naming-convention.README @@ -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 diff --git a/developer/api/index.html b/developer/api/index.html new file mode 100644 index 0000000..c0b5ab5 --- /dev/null +++ b/developer/api/index.html @@ -0,0 +1,592 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

25. API documentation

+ +

This is the homepage for all API related documentation.

+
    +
  • The api guide, which describes common workflows for using the restful API.
    • +
  • The api manual, which describes each API endpoint and its parameters, return values etc. This section is autogenerated.
    • +
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/api/manual/img/naming-convention.README b/developer/api/manual/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/developer/api/manual/img/naming-convention.README @@ -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 diff --git a/developer/api/manual/index.html b/developer/api/manual/index.html new file mode 100644 index 0000000..124d1d5 --- /dev/null +++ b/developer/api/manual/index.html @@ -0,0 +1,588 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

26. API manual

+
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/documentation/context-help/index.html b/developer/documentation/context-help/index.html new file mode 100644 index 0000000..5583632 --- /dev/null +++ b/developer/documentation/context-help/index.html @@ -0,0 +1,755 @@ + + + + + + + + + + + + + +GeoSight-OS Documentation Context Help - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

24. Context Help

+

This section describes how the context help system works.

+

24.1 Overview

+

The context help system provides an integration between the web application and the documentation.

+

+

The following concepts are used:

+
    +
  • Site: This is the area for globally setting options relating to the context help system.
    • +
  • Blocks: These are small components displayed as blocks 1️⃣ in the context help panel. Each block links to a section in the help documentation.
    • +
  • Pages: These are context help panels that are each linked to a particular URL in the application.
    • +
  • Page Blocks: These are links between pages and their constituent blocks. Each page can have many blocks and each block can be used in many pages.
    • +
+

24.2 Triggering context help

+

There are three ways to trigger context help:

+
    +
  1. From the top nav bar 1️⃣ image.png
    2. +
  2. From the side panel 1️⃣ image.png
    3. +
  3. Next to widgets (not implemented yet)
    4. +
+

24.3 Managing context help

+

We manage the context help system from django admin. You need to be a staff user to do this and have been granted read/write/update permissions on the documentation center related tables. First open your user menu 1️⃣ and then the Django Admin area 2️⃣.

+

image.png

+

Next we can drill into the documentation center to see only the relevant admin activities 1️⃣.

+

image.png

+

24.4 Site preferences

+

Our first activity is to edit the site preferences 1️⃣.

+

image.png

+

Here our goal is to set the documentation base url for the context help system 1️⃣. Use the URL for your documentation project i.e. https://unicef-drp.github.io/GeoSight-OS

+

image.png

+

24.5 Managing Pages

+

Next we need to create pages for each application end point where we want to include context sensitive help. First select pages 1️⃣ from the documentation center menu:

+

image.png

+

Now you can edit an existing page 1️⃣ or add a new one 2️⃣:

+

image.png

+

The page properties you can set are going to determine how the context help panel appears in the application when triggering the help panel 1️⃣:

+

image.png

+

Here is a detailed breakdown of the options:

+

1️⃣ Name: A symbolic name for you to easily recognise what the context help is about

+

2️⃣ Relative page url: This is the relative path to our application page (see underline in image above) e.g. /admin/importer/

+

3️⃣ Url: This is where the documentation is, relative to the documentation base URL. For example if your docs base URL is at: https://unicef-drp.github.io/GeoSight-OS/ your help context document relative URL is /administrator/guide/. This will trigger the content panel link 3️⃣ above to point to this page.

+

4️⃣ Title: This will be displayed as 1️⃣ above in the context help panel.

+

5️⃣ Intro: This will be shown as lead-in text for the context help panel. See 2️⃣ above.

+

image.png

+

On the page form you can also manage the blocks that appear in the context help.

+

24.6 Managing blocks

+

You can view and manage existing blocks from the documentation center 1️⃣ or add a new block 2️⃣. We first create a block then go back to the page to add it to the page.

+

image.png

+

We can also create a new block directly from within a page.

+
    +
  • To set a block link within the page use 1️⃣
    • +
  • To set the order in which the block appears in the help panel use 2️⃣. For ordering, lower number blocks will be listed before higher number blocks. It is up to you to ensure that each number used for ordering is unique.
    • +
  • To create a new block component for a page, use 3️⃣ and then go and choose or create the actual block content.
    • +
+

image.png

+

Let's create a new block within the context of an existing page (this is the more normal workflow).

+

image.png

+

Because we have created it within the page form, the block form appears as a popup window. We can deal with the form components as follows:

+
    +
  • The relative url 1️⃣ (based on the the documentation site wide base url preference) to the documentation page
    • +
  • The anchor 2️⃣ - this is optional and should point to a heading / subheading within the page if populated.
    • +
  • The title 3️⃣ - title for the block. This is automatically filled in from the page unless you specify an override title. Normally you would leave this blank.
    • +
  • The thumbnail 4️⃣ for the block. This is automatically linked to the first image below the anchor in the help document. Usually you would leave this blank.
    • +
  • Description 5️⃣ for the block. This will be automatically populated from the first paragraph in the linked help documentation.
    • +
+

⚠️ As you can see, the block definition requires only minimal information - the URL and optionally the anchor on the page. Anything else you specify here will override information harvested from the page and likely make your documentation more difficult to maintain.

+

image.png

+

24.7 Page Blocks

+

Generally we will not directly use the PageBlocks management area - use the Page manager to add and remove blocks from your page.

+

24.8 Conclusion and notes

+

The system for context help has been designed in a generic way. That means that you can use any web site where you can reference content with page links and anchors.

+

⛔️ One word of caution. Do not use a web site as your documentation source if you do not control that site. The content from the help site is pulled directly into your application, which could put you in a compromising position if the content is not 'on message' for your organisation.

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/documentation/easy-workflow/index.html b/developer/documentation/easy-workflow/index.html new file mode 100644 index 0000000..e36b41a --- /dev/null +++ b/developer/documentation/easy-workflow/index.html @@ -0,0 +1,724 @@ + + + + + + + + + + + + + +GeoSight-OS Documentation Home - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

22. Documentation Overview

+

This document describes the easiest workflow for editing documentation.

+

Requirements:

+
    +
  1. You need to have a GitHub account and be logged in to your account
    2. +
  2. You need to have been given access to the repo by the repo manager
    3. +
+

22.1 General Workflow

+
    +
  1. Go to the repo for the documentation.
    2. +
  2. Press the . key on your keyboard.
    3. +
  3. Select a file under the src folder to edit
    4. +
  4. Press Ctrl-S to save your work.
    5. +
  5. Go to the Source Control tab to commit your work.
    6. +
  6. Add a short, descriptive comment describing your changes.
    7. +
  7. Press the Commit and push button.
    8. +
  8. Wait a few minutes and your changes should be published live.
    9. +
+

22.2 Adding a new page

+

Any new page you create needs to be also added to mkdocs-base.yml so that it gets 'built. +If you wish to build a page but not have it in the menu system, you can give it a blank menu description e.g.

+
# Pages to render but exclude from navigation
+- "": developer/guide/templates/pull-request-template.md 
+
+

Conversely, to ensure it is shown in the menu, find the right place in the navigation tree and then insert it with a short descriptor. e.g.

+
# Pages to render and include from navigation
+- "My Menu Item": developer/guide/my-page.md 
+
+

22.3 Adding images

+

You can easily upload images into the documentation sources and then add them to your document.

+
    +
  1. Take an image using your favourite screenshot tool.
    2. +
  2. Using your file manager, drag the file from your desktop into the img folder in the relevant part of the documentation you are working on.
    3. +
  3. Shift+Drag the image into your markdown document.
    4. +
  4. Edit the image description (the part in square brackets)
    5. +
+ +

You can add a link to any text by doing the following:

+
    +
  1. Copy the link from your web browser to your clipboard.
    2. +
  2. Either + 2.1 Past the link directly into the document sources. + 2.2 or, write some words ine square brackets and paste the link in round brackets after, VSCode will create a markdown formatted link.
    3. +
+

This is a normal link https://staging-geosight.unitst.org/, this is a link.

+

The above in markdown:

+
This is a normal link https://staging-geosight.unitst.org/, [this is a link](https://staging-geosight.unitst.org/).
+
+

22.5 Page previews

+

You can easily preview the page you are working on by doing this:

+
    +
  1. Press Ctl-Shift-V to open a preview of the page you are currently working in.
    2. +
  2. Drag and drop the preview tab to the right side of the editing environment for a side-by-side view.
    3. +
+

22.6 Leaving the editor viewer

+

How to leave the interactive editor.

+
    +
  1. Click the 'hamburger' menu and go to the repository.
    2. +
  2. Wait a few moments and the 'normal' GitHub page will load.
    3. +
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/documentation/img/check-branch.png b/developer/documentation/img/check-branch.png new file mode 100644 index 0000000..1955d1d Binary files /dev/null and b/developer/documentation/img/check-branch.png differ diff --git a/developer/documentation/img/context-help-1.png b/developer/documentation/img/context-help-1.png new file mode 100644 index 0000000..ed08203 Binary files /dev/null and b/developer/documentation/img/context-help-1.png differ diff --git a/developer/documentation/img/context-help-10.png b/developer/documentation/img/context-help-10.png new file mode 100644 index 0000000..855c0cf Binary files /dev/null and b/developer/documentation/img/context-help-10.png differ diff --git a/developer/documentation/img/context-help-11.png b/developer/documentation/img/context-help-11.png new file mode 100644 index 0000000..d1c3b95 Binary files /dev/null and b/developer/documentation/img/context-help-11.png differ diff --git a/developer/documentation/img/context-help-12.png b/developer/documentation/img/context-help-12.png new file mode 100644 index 0000000..3c0b349 Binary files /dev/null and b/developer/documentation/img/context-help-12.png differ diff --git a/developer/documentation/img/context-help-13.png b/developer/documentation/img/context-help-13.png new file mode 100644 index 0000000..4c00432 Binary files /dev/null and b/developer/documentation/img/context-help-13.png differ diff --git a/developer/documentation/img/context-help-14.png b/developer/documentation/img/context-help-14.png new file mode 100644 index 0000000..1240ac1 Binary files /dev/null and b/developer/documentation/img/context-help-14.png differ diff --git a/developer/documentation/img/context-help-15.png b/developer/documentation/img/context-help-15.png new file mode 100644 index 0000000..907c517 Binary files /dev/null and b/developer/documentation/img/context-help-15.png differ diff --git a/developer/documentation/img/context-help-16.png b/developer/documentation/img/context-help-16.png new file mode 100644 index 0000000..f1f42c8 Binary files /dev/null and b/developer/documentation/img/context-help-16.png differ diff --git a/developer/documentation/img/context-help-17.png b/developer/documentation/img/context-help-17.png new file mode 100644 index 0000000..0d07e78 Binary files /dev/null and b/developer/documentation/img/context-help-17.png differ diff --git a/developer/documentation/img/context-help-2.png b/developer/documentation/img/context-help-2.png new file mode 100644 index 0000000..71344c0 Binary files /dev/null and b/developer/documentation/img/context-help-2.png differ diff --git a/developer/documentation/img/context-help-3.png b/developer/documentation/img/context-help-3.png new file mode 100644 index 0000000..19e75a1 Binary files /dev/null and b/developer/documentation/img/context-help-3.png differ diff --git a/developer/documentation/img/context-help-4.png b/developer/documentation/img/context-help-4.png new file mode 100644 index 0000000..dadb859 Binary files /dev/null and b/developer/documentation/img/context-help-4.png differ diff --git a/developer/documentation/img/context-help-5.png b/developer/documentation/img/context-help-5.png new file mode 100644 index 0000000..baa76a0 Binary files /dev/null and b/developer/documentation/img/context-help-5.png differ diff --git a/developer/documentation/img/context-help-6.png b/developer/documentation/img/context-help-6.png new file mode 100644 index 0000000..d2d6453 Binary files /dev/null and b/developer/documentation/img/context-help-6.png differ diff --git a/developer/documentation/img/context-help-7.png b/developer/documentation/img/context-help-7.png new file mode 100644 index 0000000..fd32afc Binary files /dev/null and b/developer/documentation/img/context-help-7.png differ diff --git a/developer/documentation/img/context-help-8.png b/developer/documentation/img/context-help-8.png new file mode 100644 index 0000000..02bd567 Binary files /dev/null and b/developer/documentation/img/context-help-8.png differ diff --git a/developer/documentation/img/context-help-9.png b/developer/documentation/img/context-help-9.png new file mode 100644 index 0000000..c4ba5d5 Binary files /dev/null and b/developer/documentation/img/context-help-9.png differ diff --git a/developer/documentation/img/edit-navigation-1.png b/developer/documentation/img/edit-navigation-1.png new file mode 100644 index 0000000..33f76ec Binary files /dev/null and b/developer/documentation/img/edit-navigation-1.png differ diff --git a/developer/documentation/img/edit-navigation-2.png b/developer/documentation/img/edit-navigation-2.png new file mode 100644 index 0000000..dffd480 Binary files /dev/null and b/developer/documentation/img/edit-navigation-2.png differ diff --git a/developer/documentation/img/edit-navigation-3.png b/developer/documentation/img/edit-navigation-3.png new file mode 100644 index 0000000..baf29c4 Binary files /dev/null and b/developer/documentation/img/edit-navigation-3.png differ diff --git a/developer/documentation/img/edit-navigation-4.png b/developer/documentation/img/edit-navigation-4.png new file mode 100644 index 0000000..bfb762d Binary files /dev/null and b/developer/documentation/img/edit-navigation-4.png differ diff --git a/developer/documentation/img/fork-repo-1.png b/developer/documentation/img/fork-repo-1.png new file mode 100644 index 0000000..b5b30f5 Binary files /dev/null and b/developer/documentation/img/fork-repo-1.png differ diff --git a/developer/documentation/img/fork-repo-2.png b/developer/documentation/img/fork-repo-2.png new file mode 100644 index 0000000..3c49701 Binary files /dev/null and b/developer/documentation/img/fork-repo-2.png differ diff --git a/developer/documentation/img/html-workflow.png b/developer/documentation/img/html-workflow.png new file mode 100644 index 0000000..cdd6f39 Binary files /dev/null and b/developer/documentation/img/html-workflow.png differ diff --git a/developer/documentation/img/naming-convention.README b/developer/documentation/img/naming-convention.README new file mode 100644 index 0000000..b7fd046 --- /dev/null +++ b/developer/documentation/img/naming-convention.README @@ -0,0 +1,7 @@ +# Image naming convention + +Images should be named according to reference doc, sub-section and order in 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 diff --git a/developer/documentation/img/new-file-1.png b/developer/documentation/img/new-file-1.png new file mode 100644 index 0000000..4d1a2f2 Binary files /dev/null and b/developer/documentation/img/new-file-1.png differ diff --git a/developer/documentation/img/new-file-2.png b/developer/documentation/img/new-file-2.png new file mode 100644 index 0000000..27932ea Binary files /dev/null and b/developer/documentation/img/new-file-2.png differ diff --git a/developer/documentation/img/new-file-3.png b/developer/documentation/img/new-file-3.png new file mode 100644 index 0000000..b62d765 Binary files /dev/null and b/developer/documentation/img/new-file-3.png differ diff --git a/developer/documentation/img/new-file-4.png b/developer/documentation/img/new-file-4.png new file mode 100644 index 0000000..cd5034b Binary files /dev/null and b/developer/documentation/img/new-file-4.png differ diff --git a/developer/documentation/img/pdf-workflow.png b/developer/documentation/img/pdf-workflow.png new file mode 100644 index 0000000..416d418 Binary files /dev/null and b/developer/documentation/img/pdf-workflow.png differ diff --git a/developer/documentation/img/pull-request-1.png b/developer/documentation/img/pull-request-1.png new file mode 100644 index 0000000..f8a4776 Binary files /dev/null and b/developer/documentation/img/pull-request-1.png differ diff --git a/developer/documentation/img/pull-request-2.png b/developer/documentation/img/pull-request-2.png new file mode 100644 index 0000000..123f29f Binary files /dev/null and b/developer/documentation/img/pull-request-2.png differ diff --git a/developer/documentation/img/upload-img-1.png b/developer/documentation/img/upload-img-1.png new file mode 100644 index 0000000..6fb165e Binary files /dev/null and b/developer/documentation/img/upload-img-1.png differ diff --git a/developer/documentation/img/upload-img-2.png b/developer/documentation/img/upload-img-2.png new file mode 100644 index 0000000..80ae899 Binary files /dev/null and b/developer/documentation/img/upload-img-2.png differ diff --git a/developer/documentation/img/upload-img-3.png b/developer/documentation/img/upload-img-3.png new file mode 100644 index 0000000..569e2c0 Binary files /dev/null and b/developer/documentation/img/upload-img-3.png differ diff --git a/developer/documentation/img/upload-img-4.png b/developer/documentation/img/upload-img-4.png new file mode 100644 index 0000000..e11ce48 Binary files /dev/null and b/developer/documentation/img/upload-img-4.png differ diff --git a/developer/documentation/img/web-editor-1.png b/developer/documentation/img/web-editor-1.png new file mode 100644 index 0000000..43adf54 Binary files /dev/null and b/developer/documentation/img/web-editor-1.png differ diff --git a/developer/documentation/img/web-editor-2.png b/developer/documentation/img/web-editor-2.png new file mode 100644 index 0000000..d3300c3 Binary files /dev/null and b/developer/documentation/img/web-editor-2.png differ diff --git a/developer/documentation/img/web-editor-3.png b/developer/documentation/img/web-editor-3.png new file mode 100644 index 0000000..9d48cdb Binary files /dev/null and b/developer/documentation/img/web-editor-3.png differ diff --git a/developer/documentation/img/web-editor-4.png b/developer/documentation/img/web-editor-4.png new file mode 100644 index 0000000..84c9a0f Binary files /dev/null and b/developer/documentation/img/web-editor-4.png differ diff --git a/developer/documentation/img/web-editor-5.png b/developer/documentation/img/web-editor-5.png new file mode 100644 index 0000000..ab3793f Binary files /dev/null and b/developer/documentation/img/web-editor-5.png differ diff --git a/developer/documentation/img/web-editor-6.png b/developer/documentation/img/web-editor-6.png new file mode 100644 index 0000000..c21a126 Binary files /dev/null and b/developer/documentation/img/web-editor-6.png differ diff --git a/developer/documentation/img/web-editor-7.png b/developer/documentation/img/web-editor-7.png new file mode 100644 index 0000000..4f758d7 Binary files /dev/null and b/developer/documentation/img/web-editor-7.png differ diff --git a/developer/documentation/index.html b/developer/documentation/index.html new file mode 100644 index 0000000..e182a6c --- /dev/null +++ b/developer/documentation/index.html @@ -0,0 +1,591 @@ + + + + + + + + + + + + + +GeoSight-OS Documentation Home - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

21. Documentation

+

In this section of the documentation, we explain how to work with the documentation. The content is organised as follows:

+
    +
  • Overview: Here we outline the documentation system and the standard workflows needed.
    • +
  • Context help: Here we outline the procedure for adding context help into the application and linking it to this documentation tree.
    • +
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/documentation/overview/index.html b/developer/documentation/overview/index.html new file mode 100644 index 0000000..1217239 --- /dev/null +++ b/developer/documentation/overview/index.html @@ -0,0 +1,910 @@ + + + + + + + + + + + + + +GeoSight-OS Documentation Home - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

23. Documentation Overview

+

This section provides an overview of how the documentation system works.

+

23.1 Background

+

Welcome to the instructions for those wishing to contribute to our documentation!

+

Our documentation system is based on the popular mkdocs system. We encourage you to read the upstream documentation from mkdocs for the finer details of how mkdocs. In particular, read this page before you get to work. Mkdocs is not hard, but it may feel initially a little different if you are used to creating your documentation in word.

+

We use mkdocs because it has some great and useful features. Most especially:

+
    +
  • The code and the documentation are versioned together. This means that for whatever version of the code we have in our production release, we can be sure the documentation matches that release. We can also look back at changes over time through the version history when needed.
    • +
  • It can render beautiful static (not needing a backend server) web sites with great features like search, styling, intuitive navigation etc.
    • +
  • It can optionally render PDF documents from the same source markdown.
    • +
  • An ecosystem of plugins and themes makes mkdocs really flexible and extensible.
    • +
+

23.1.1 Some terminology

+

In our documentation, we have organised the information using a specific nomenclature:

+
    +
  • guide: A guide is a multi-step workflow / tutorial that leads your through common activities.
    • +
  • manual: A collection of documents that describe each part of the project in a matter of fact way without presupposing any specific workflow is being undertaken.
    • +
+

For each of the main topic areas (user, admin, developer, devops, api user) we provide guides and manuals as is appropriate.

+

23.1.2 Organisation

+

The documentation is broadly organised in the following structure. This structure may change over time as sections are added / moved / removed:

+
src
+├── about
+├── administrator
+│   ├── guide
+│   └── manual
+├── developer
+│   ├── documentation
+│   ├── guide
+│   └── manual
+├── devops
+│   ├── guide
+│   └── manual
+└── user
+    ├── api
+    ├── guide
+    ├── manual
+    └── quickstart
+
+

23.2 File naming conventions

+

Please follow these conventions when writing your documentation:

+
    +
  1. Write file names in all lower case, with hyphens separating words (no spaces). e.g. important-file.md not Important File.md or other deviations.
    2. +
  2. Place the image files in the img folder adjacent to your content.
    3. +
  3. Do not abbreviate any words in file names - but try to use terse, descriptive names.
    4. +
  4. Place your content into the appropriate place as outline in the structure above.
    5. +
  5. Each file should only one level one heading e.g. # Page title
    6. +
  6. Headings and subheadings should be written as a terse phrase starting with a capital letter and subsequent words in lower case unless they are proper nouns. Do not place a colon after the heading.
    7. +
  7. Use unicode number markers to reference numbers in images e.g. 1️⃣
    8. +
  8. Every heading / sub-heading should have a single line underneath it summarising the content that will follow. This sentence will be used in the help center in the application to give the user a reference point for the text that will follow. It also makes the help text more consistent and readable.
    9. +
  9. For every section that images, the first image will be used as the thumbnail if the heading is referenced from the application.
    10. +
+

23.3 Contributing to the documentation

+

✏ Note: The repo name in the images below is blurred out, you should work against the GeoRepo-OS repository when following these notes.

+

To start adding to the documentation navigate to the home page of the repository.

+

Once on the repository home page, 1️⃣ click on Fork +Fork Repository 1

+

On the next page 1️⃣ Make sure your github account is selected as the owner and 2️⃣ make sure the "Copy the main branch only" option is ticked as you will only need the main branch. +Fork Repository 2

+

Once you have forked the repository, ensure that you are working in the main branch. +Change Branch

+

Once you are in your fork of the repository, click on . on your keyboard. This will open a web editor where you can begin adding to, or editing, the documentation. +Web Editor 1

+

Once the editor loads, you will be greeted by 1️⃣ a preview of the project's README.txt. 2️⃣ Click on the docs directory in the menu on the left, this will expand the directory. To confirm that you are working in the right branch 3️⃣️ it will say main in the bottom left of the editor. +Web Editor 2

+

Once you have expanded the docs directory, 1️⃣ click on the src directory. All sub-directories within the src directory contain the files that become the documentation. Each sub-directory contains an index.md file that is required for the building of the documentation and static site. If you add a new sub-directory into any folder it must also contain a populated index.md file. +Web Editor 3

+

Once you have chosen which section of documentation you would like to edit (e.g. user/guide/index.md), click on the file and it will open in the web editor. +Web Editor 4

+

Once you have the file open, you can start adding to the documentation using Markdown syntax. If you need to add images to your documentation, add them to the relative img sub-directories following the naming conventions set out in the naming-convention.README within the img folders. +Web Editor 5

+

When you have completed making additions to (or editing) the documentation, 1️⃣ click on the source control tab then 2️⃣ click on the plus symbol next to the changes you are finished with to stage them, 3️⃣️ add a commit message that is associated with the work you have done, and the 4️⃣ Click on Commit & Push +Web Editor 6

+

Once you have committed your changes, 1️⃣ Click on the burger menu and then 2️⃣ click on Go To Repository +Web Editor 7

+

Your fork of the repository will be opened in a new tab within your browser, navigate to that tab. Once there 1️⃣ ensure you are on the main, you should see how many commits ahead of the upstream branch you are, then 2️⃣ click on Contribute-> Open pull request. +Pull Request 1

+

On the next screen, 1️⃣ give your pull request a meaningful title, 2️⃣ give additional details regarding changes made in the larger text box, then 3️⃣️ click on Create pull request. Also ensure you are creating a pull request to the upstream main branch from your main branch. +Pull Request 2

+

Once your pull request is opened you need to wait for it to be merged before you can open a new one.

+

23.4 Creating new files

+

23.4.1 Page metadata

+

Whenever you create a new file, you should add the standard header to the top of the file:

+
---
+title: GeoRepo-OS Documentation 
+summary: GeoRepo is a UNICEF's geospatial web-based data storage and administrative boundary harmonization platform.
+    - Tim Sutton
+    - Dimas Tri Ciputra
+    - Danang Tri Massandy
+date: 2023-08-03
+copyright: Copyright 2023, Unicef
+contact: georepo-no-reply@unicef.org
+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.
+#context_id: 1234
+---
+
+

The summary can be updated to include your name for documents you contribute to.

+

The context_id is used to create a unique permalink to this document, and is optional. See further down in this document for more details.

+ +

All pages need to be added to the 'Nav' section of the mkdocs-base.yml file. This will ensure that it is available in the menus and that mkdocs renders without errors. For example, if you wish to add a new page to the User Guide area, in Nav you would add a line like this:

+

- "Navigating the map": users/guide/map-navigation.md

+

Sometimes you may not wish to have the new page displayed in the menu system (this can be useful when, for example, it is accessed via a link in another page. In these cases, leave the menu entry part blank e.g.

+

- "": users/guide/map-navigation.md

+

Mkdocs will still generate the page but it will not be added to the menu.

+

23.5 Technical notes

+

23.5.1 Working locally

+

If you want to work with the documentation locally (i.e. directly on your PC), you need to follow this general process:

+
    +
  1. Install python
    2. +
  2. Install pip
    3. +
  3. Install virtualenv (pip install virtualenv)
    4. +
  4. Make the docs folder your working directory (cd docs)
    5. +
  5. Create the virtual env in the docs folder (python -m venv env)
    6. +
  6. Activate the venv (source env/bin/activate)
    7. +
  7. Install the python modules listed in docs/requirements.txt (pip install -r requirements.txt)
    8. +
  8. If you are on Linux or macOS, open the docs directory in a shell and run build-docs-html.sh
    9. +
  9. In the docs directory, run mkdocs serve
    10. +
  10. Open your web browser at https://localhost:8000 to view the rendered docs.
    11. +
+

Note that mkdocs serve will dynamically re-render the docs any time you make a change. The process above is illustrated in the diagram below:

+

+

23.5.2 Hooks

+

We implement two hooks (plugins for mkdocs that are invoked during the docs rendering process).

+
    +
  • uuid_redirects_hook.py - this is used to handle page redirects from a uuid - see below for more details
    • +
  • python_manual_hook.py - this is used to auto-generate the reference guide for the python modules, classes and functions that make up the code base for this project.
    • +
+ +

If you are a developer, you should be aware of the workflow for creating user and administrator documentation for each page you create.

+

Every page should have a help link on it that leads to the appropriate manual page. The workflow for doing this is:

+
    +
  1. Generate a new page UUID using the provided python utility e.g. ./create-uuid.py
    2. +
  2. Create a new page in the appropriate manual section e.g. docs/src/user/manual/login.md
    3. +
  3. In the metadata section at the top of the page, add the context id e.g. context_id: V4cVEFd2TmwYJVb5HvWRwa
    4. +
  4. In your django view, set up your help button to point to the site url and your context id. e.g. https://siteurl/V4cVEFd2TmwYJVb5HvWRwa
    5. +
+

Whenever the user visits the page using the UUID URL, they will be redirected to the correct page e.g. https://siteurl/login/. This system protects us from file renaming and reorganising on the site, and ensures that the help link will always remain valid.

+

23.5.4 Generating PDFS

+

To generate PDFS, cd into GEOREPO-OS/docs and then run the build-docs-pdf in a local terminal

+

23.5.5 Generating Static Site

+

To generate HTML, cd into GEOREPO-OS/docs and then run the build-docs-html in a local terminal. +You can then run mkdocs serve to generate the static site on your local host, if there is a port conflict you can specify the port using the -a flag e.g mkdocs serve -a 127.0.0.1:8001.

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/guide/architecture/index.html b/developer/guide/architecture/index.html new file mode 100644 index 0000000..a9d8626 --- /dev/null +++ b/developer/guide/architecture/index.html @@ -0,0 +1,725 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

10. System architecture

+

In this section, we outline the system architecture using ER Diagrams, Software Component Diagrams etc. and key libraries / frameworks used in this project.

+

10.1 Software components used

+ +

The following is a list, with brief descriptions, of the key components used in creating this platform. Please refer to their individual documentation for in-depth technical information.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
LogoNameNotes
DjangoDjango makes it easier to build better web apps more quickly and with less code.
File:React-icon.svg - Wikimedia CommonsReactJSReact lets you build user interfaces out of individual pieces called components. Create your own React components like Thumbnail, LikeButton, and Video. Then combine them into entire screens, pages, and apps.
MUIMove faster with intuitive React UI tools. MUI offers a comprehensive suite of free UI tools to help you ship new features faster. Start with Material UI, our fully-loaded component library, or bring your own design system to our production-ready components.
DockerAccelerate how you build, share, and run applications. Docker helps developers build, share, and run applications anywhere — without tedious environment configuration or management.
CeleryCelery is a simple, flexible, and reliable distributed system to process vast amounts of messages, while providing operations with the tools required to maintain such a system. It’s a task queue with focus on real-time processing, while also supporting task scheduling.
Celery BeatThis extension enables you to store the periodic task schedule in your database. The periodic tasks can be managed from the Django Admin interface, where you can create, edit and delete periodic tasks and how often they should run.
Django Rest FrameworkDjango REST framework is a powerful and flexible toolkit for building Web APIs.
MapLibreOpen-source mapping libraries for web and mobile app developers.
deck.gl is a WebGL-powered framework for visual exploratory data analysis of large datasets.
PostGISPostGIS extends the capabilities of the PostgreSQL relational database by adding support storing, indexing and querying geographic data.
PostgreSQLPostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.
TegolaAn open source vector tile server written in Go, Tegola takes geospatial data and slices it into vector tiles that can be efficiently delivered to any client.
GDALGDAL is a translator library for raster and vector geospatial data formats that is released under an MIT style Open Source License by the Open Source Geospatial Foundation. As a library, it presents a single raster abstract data model and single vector abstract data model to the calling application for all supported formats. It also comes with a variety of useful command line utilities for data translation and processing.
+

10.2 Docker components

+

The following diagram represents the docker containers, ports and volumes that are used to compose this platform.

+ +

Architecture Docker Diagram

+

10.3 ER diagram

+ +

The following diagram represents all of the database entities that are created by the Django ORM (Object Relational Mapper). Right click the image and open it in its own tab to see it at full resolution.

+ +

Architecture ERD

+

🪧 If you already have all of the above criteria met, you can move on to Prerequisites to start the process of getting your local development environment set up.

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/guide/building/index.html b/developer/guide/building/index.html new file mode 100644 index 0000000..0afaef1 --- /dev/null +++ b/developer/guide/building/index.html @@ -0,0 +1,683 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

15. Building the dev environment

+

This section covers the process of building and running the application from your IDE.

+

🚩 Make sure you have gone through the IDE Setup Process before following these notes.

+

Press Ctrl -> P 1️⃣ and then >and search for Rebuild. Select Dev Containers: Rebuild and Reopen in Container2️⃣. This will essentially mount your code tree inside a docker container and switch the development context of VSCode to be inside the container where all of the python etc. dependencies will be installed.

+

image.png

+

Once the task is running, a notification 1️⃣ will be shown in the bottom right of the VSCode window. Clicking in the notification will show you the setup progress 2️⃣. Note that this make take quite a while depending on the internet bandwidth you have and the CPU power of your machine.

+

image.png

+

15.1 Open a dev container terminal

+

Open terminal within the dev container context by clicking the +icon in the terminal pane 1️⃣. The new terminal 2️⃣ will show up in the list of running terminals 3️⃣

+

image.png

+

15.2 Install FrontEnd libraries

+
make frontend-dev
+
+

image.png

+

15.3 Run django migration

+
cd /home/web/project/django_project
+python manage.py migrate
+
+

15.4 Create super user

+
cd /home/web/project/django_project
+python manage.py createsuperuser
+
+

During this process you will be prompted for your user name (defaults to root), email address and a password (which you need to confirm). Complete these as needed.

+

15.5 Viewing your test instance

+

After completing the steps above, you should have the development server available on port 2000 of your local host:

+
http://localhost:2000
+
+

image.png

+

The site will be rather bare bones since it will need to be configured in the admin area to set up the theme etc.

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/guide/cloning/index.html b/developer/guide/cloning/index.html new file mode 100644 index 0000000..f37bbfc --- /dev/null +++ b/developer/guide/cloning/index.html @@ -0,0 +1,595 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

12. Checking out the code

+

This section outlines the process of checking out the code for local development.

+

🚩 Make sure you have gone through the Prerequisites Section before following these notes.

+

Git Code check out [PROJECT_URL]

+
git clone https://github.com/project-name/repository.git
+
+ +

📒Which branch to use?: Note that we deploy our staging work from the develop branch and our production environment from the main branch. If you are planning on contributing improvements to the project, please submit them against the develop branch.

+

🪧 Now that you have the code checked out, move on to the IDE Setup documentation.

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/guide/configuration/index.html b/developer/guide/configuration/index.html new file mode 100644 index 0000000..4fa9377 --- /dev/null +++ b/developer/guide/configuration/index.html @@ -0,0 +1,684 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

14. Project setup

+ +

14.1 Clone [PROJECT_NAME] repository

+

This will clone the [PROJECT_NAME] repository to your machine +

git clone https://github.com/project/repository.git
+
+ +

14.2 Set up the project

+

This will set up the [PROJECT_NAME] project on your machine

+
cd [PROJECT_NAME]
+cd deployment
+cp docker-compose.override.template.yml docker-compose.override.yml
+cp .template.env .env
+cd ..
+make up
+
+

Wait until everything is done.

+

After everything is done, open up a web browser and go to http://127.0.0.1/ and the dashboard will open:

+

By Default, we can use the admin credential:

+
username : admin
+password : admin
+
+

14.3 Set up different environment

+

To set up different environment, for example the Default credential, or the port of server, open deployment/.env. +You can check the description below for each of variable.

+
COMPOSE_PROJECT_NAME=[PROJECT_NAME]
+NGINX_TAG=0.0.1  -> Change this for different nginx image
+DJANGO_TAG=0.0.1 -> Change this for different django image
+DJANGO_DEV_TAG=0.0.1 -> Change this for different django dev image
+
+# Environments
+DJANGO_SETTINGS_MODULE=core.settings.prod -> Change this to use different django config file
+ADMIN_USERNAME=admin -> Default admin username 
+ADMIN_PASSWORD=admin -> Default admin password
+ADMIN_EMAIL=admin@example.com -> Default admin email
+INITIAL_FIXTURES=True
+HTTP_PORT=80 -> Change the port of nginx
+
+# Database Environment
+DATABASE_NAME=django -> Default database name
+DATABASE_USERNAME=docker -> Default database username
+DATABASE_PASSWORD=docker -> Default database password
+DATABASE_HOST=db -> Default database host. Change this if you use cloud database or any new docker container.
+RABBITMQ_HOST=rabbitmq
+
+# Onedrive
+PUID=1000
+PGID=1000
+
+

After you change the desired variable and do make up. It will rerun the project with new environment.

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/guide/design/index.html b/developer/guide/design/index.html new file mode 100644 index 0000000..7314b18 --- /dev/null +++ b/developer/guide/design/index.html @@ -0,0 +1,677 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

16. Design

+ +

This section describes the visual design approach for the user interface.

+

Design Overview

+

16.1 Design sheet

+

The following documents provide guidance for the standard visual design we use when building the site:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PreviewNameNotes
ColoursColoursColour Palettes
ButtonsButtonsDesigns for Buttons.
Form FieldsForm FieldsForm elements such as input boxes, select lists, radio buttons etc.
IconsIconsStandard iconography to be used in forms and views.
TablesTablesDesign for tables and presentation of tabular data.
OthersOthersOther user interface elements.
+

🪧 Once you have reviewed the design sheets, you can move on to our Roadmap.

+

16.2 Wire-frame model

+ +

Wire-frame Model

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/guide/ide-setup/index.html b/developer/guide/ide-setup/index.html new file mode 100644 index 0000000..b63de2f --- /dev/null +++ b/developer/guide/ide-setup/index.html @@ -0,0 +1,855 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

13. Setting up your IDE

+

This section outlines the process for configuring your IDE for development.

+

🚩 Make sure you have gone through the Cloning Section before following these notes.

+

13.1 VS Code setup

+

Open the project in VSCode (1️⃣, 2️⃣) by navigating the the place on your file system where you checked out the code in the pre-requisites step above (3️⃣).

+

IDE Setup 1.png

+

Accept the 'trust authors' prompt

+

IDE Setup 2.png

+

13.1.1 Copying the .env

+

Copy the template.env to .env

+

IDE Setup 3.png

+

Edit the .env file and change the

+
DJANGO_SETTINGS_MODULE=core.settings.prod
+
+

to

+
DJANGO_SETTINGS_MODULE=core.settings.dev
+
+

image.png

+

13.1.2 Override Docker configurations

+

We are going to copy the docker overrides template to a local file that will not be under version control.

+

image.png

+

Rename the file to docker-compose.override.yml

+

image.png

+

Initially you will not need to change anything in this file, though you may want to take a look through the various configurations provided here if you want to tweak your local setup.

+

Now that you have your IDE set up, we can move on to building the project.

+

13.2 Using PyCharm

+

📒 ⛔️ This section needs to be reviewed and organised into our docs framework.

+

This section is for using pycharm.

+

Requirements:

+
    +
  • Pycharm
    • +
  • Finished Setting up the project
    • +
+

13.3 Setup interpreter

+
    +
  1. +

    Go to File -> Settings -> Project -> Project Interpreter. Then click on the cog -> add +
    Project Interpreter

    +
    2. +
  2. +

    Go to the ssh interpreter tab and fill in the form as below +
    Project Interpreter

    +
    3. +
  3. +

    Click next and fill in docker as the password +
    Project Interpreter

    +
    4. +
  4. +

    Click next and change the interpreter as below, then click finish. +
    Project Interpreter

    +
    5. +
  5. +

    After you click finish, it will show all of the packages like below. +
    Project Interpreter

    +
    6. +
  6. +

    In current page, click path mappings, click + button and put local path to where the project (django-project folder) and remote path is like below. and click oK. +
    Project Interpreter

    +
    7. +
+

Now the interpreter is done. When we restart the machine, we need to do make up to run the project.

+

13.4 Setup run configuration

+

After the interpreter is done, we need configuration to run the project in development mode.

+
    +
  1. +

    Click "Add configuration" like in the cursor in the image below. (top-right) +
    Project Interpreter

    +
    2. +
  2. +

    There will be a popup, and click +, then click django server like below +
    Project Interpreter +
    Project Interpreter

    +
    3. +
  3. +

    It will show the form and fill like below. +
    Project Interpreter

    +
    4. +
  4. +

    Don't click the OK yet, but click Environment Variables and add environments like below (by clicking + button). +
    Project Interpreter

    +
    5. +
  5. +

    After that, click OK.

    +
    6. +
  6. +

    Now we need to run the server by clicking go button in below image. +
    Project Interpreter

    +
    7. +
  7. +

    When we click the go button, pycharm will run a process until like image below. +
    Project Interpreter

    +
    8. +
  8. +

    Now it is done. We can access the development server in http://localhost:2000/

    +
    9. +
+

This development mode is DEBUG mode, and also whenever we change the code, the site will also change in runtime.

+

For more information how to set up on pycharm, please visit Using a Docker Compose-Based Python Interpreter in PyCharm

+

13.5 Quick setup guide

+

⛔️📒 This content needs to be reviewed and moved to the readme.

+

13.5.1 Production

+
git clone https://github.com/project-name/repository
+cd project-name/deployment
+docker-compose up -d
+
+

The web will be available at http://127.0.0.1/

+

To stop containers:

+
docker-compose kill
+
+

To stop and delete containers:

+
docker-compose down
+
+

13.5.2 Development

+
git clone https://github.com/project-name/repository
+cd project-name/deployment
+cp .template.env .env
+cp docker-compose.override.template.yml docker-compose.override.yml
+
+

After that,

+
    +
  • open new terminal
    • +
  • on folder root of project, do
    • +
+
make frontend-dev
+
+

Wait until it is done +when there is sentence "webpack xxx compiled successfully in xxx ms".
+After that, don't close the terminal. +If it is accidentally closed, do make frontend-dev again

+

Next step: +- Open new terminal +- Do commands below +

make up
+make dev
+
+

Wait until it is on.

+

The web can be accessed using http://localhost:2000/

+

If the web is taking long time to load, restart project-name_dev container by make dev-reload.
+The sequence should be make frontend-dev, after that run or restart project-name_dev.

+

To stop dev:

+
make dev-kill
+
+

To reload container:

+
make dev-reload
+
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/guide/img/1.png b/developer/guide/img/1.png new file mode 100644 index 0000000..4a8ebf7 Binary files /dev/null and b/developer/guide/img/1.png differ diff --git a/developer/guide/img/10.png b/developer/guide/img/10.png new file mode 100644 index 0000000..febfae5 Binary files /dev/null and b/developer/guide/img/10.png differ diff --git a/developer/guide/img/11.png b/developer/guide/img/11.png new file mode 100644 index 0000000..0748ab0 Binary files /dev/null and b/developer/guide/img/11.png differ diff --git a/developer/guide/img/12.png b/developer/guide/img/12.png new file mode 100644 index 0000000..26eda82 Binary files /dev/null and b/developer/guide/img/12.png differ diff --git a/developer/guide/img/13.png b/developer/guide/img/13.png new file mode 100644 index 0000000..aab1614 Binary files /dev/null and b/developer/guide/img/13.png differ diff --git a/developer/guide/img/2.png b/developer/guide/img/2.png new file mode 100644 index 0000000..6648990 Binary files /dev/null and b/developer/guide/img/2.png differ diff --git a/developer/guide/img/3.png b/developer/guide/img/3.png new file mode 100644 index 0000000..6a431cf Binary files /dev/null and b/developer/guide/img/3.png differ diff --git a/developer/guide/img/4.png b/developer/guide/img/4.png new file mode 100644 index 0000000..69d0b72 Binary files /dev/null and b/developer/guide/img/4.png differ diff --git a/developer/guide/img/5.png b/developer/guide/img/5.png new file mode 100644 index 0000000..974a089 Binary files /dev/null and b/developer/guide/img/5.png differ diff --git a/developer/guide/img/6.png b/developer/guide/img/6.png new file mode 100644 index 0000000..0fbedb9 Binary files /dev/null and b/developer/guide/img/6.png differ diff --git a/developer/guide/img/7.png b/developer/guide/img/7.png new file mode 100644 index 0000000..5f28dee Binary files /dev/null and b/developer/guide/img/7.png differ diff --git a/developer/guide/img/8.png b/developer/guide/img/8.png new file mode 100644 index 0000000..8f63d7b Binary files /dev/null and b/developer/guide/img/8.png differ diff --git a/developer/guide/img/9.png b/developer/guide/img/9.png new file mode 100644 index 0000000..8961893 Binary files /dev/null and b/developer/guide/img/9.png differ diff --git a/developer/guide/img/architecture-celery.svg b/developer/guide/img/architecture-celery.svg new file mode 100644 index 0000000..82900b1 --- /dev/null +++ b/developer/guide/img/architecture-celery.svg @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + diff --git a/developer/guide/img/architecture-deckgl.png b/developer/guide/img/architecture-deckgl.png new file mode 100644 index 0000000..bf29c4b Binary files /dev/null and b/developer/guide/img/architecture-deckgl.png differ diff --git a/developer/guide/img/architecture-docker.svg b/developer/guide/img/architecture-docker.svg new file mode 100644 index 0000000..4242689 --- /dev/null +++ b/developer/guide/img/architecture-docker.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/developer/guide/img/architecture-drf.png b/developer/guide/img/architecture-drf.png new file mode 100644 index 0000000..73de34f Binary files /dev/null and b/developer/guide/img/architecture-drf.png differ diff --git a/developer/guide/img/architecture-gdal.png b/developer/guide/img/architecture-gdal.png new file mode 100644 index 0000000..7329ebe Binary files /dev/null and b/developer/guide/img/architecture-gdal.png differ diff --git a/developer/guide/img/architecture-maplibre-logo.svg b/developer/guide/img/architecture-maplibre-logo.svg new file mode 100644 index 0000000..c007c4e --- /dev/null +++ b/developer/guide/img/architecture-maplibre-logo.svg @@ -0,0 +1,12 @@ + diff --git a/developer/guide/img/architecture-material-ui.svg b/developer/guide/img/architecture-material-ui.svg new file mode 100644 index 0000000..cbcd08c --- /dev/null +++ b/developer/guide/img/architecture-material-ui.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/developer/guide/img/architecture-postgis.svg b/developer/guide/img/architecture-postgis.svg new file mode 100644 index 0000000..ea09e7f --- /dev/null +++ b/developer/guide/img/architecture-postgis.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/developer/guide/img/architecture-postgresql.png b/developer/guide/img/architecture-postgresql.png new file mode 100644 index 0000000..94612cf Binary files /dev/null and b/developer/guide/img/architecture-postgresql.png differ diff --git a/developer/guide/img/architecture-tegola.png b/developer/guide/img/architecture-tegola.png new file mode 100644 index 0000000..12fb99d Binary files /dev/null and b/developer/guide/img/architecture-tegola.png differ diff --git a/developer/guide/img/building-1.png b/developer/guide/img/building-1.png new file mode 100644 index 0000000..42059f9 Binary files /dev/null and b/developer/guide/img/building-1.png differ diff --git a/developer/guide/img/building-2.png b/developer/guide/img/building-2.png new file mode 100644 index 0000000..5a6cc5c Binary files /dev/null and b/developer/guide/img/building-2.png differ diff --git a/developer/guide/img/building-3.png b/developer/guide/img/building-3.png new file mode 100644 index 0000000..d984996 Binary files /dev/null and b/developer/guide/img/building-3.png differ diff --git a/developer/guide/img/building-4.png b/developer/guide/img/building-4.png new file mode 100644 index 0000000..27e83b3 Binary files /dev/null and b/developer/guide/img/building-4.png differ diff --git a/developer/guide/img/building-5.png b/developer/guide/img/building-5.png new file mode 100644 index 0000000..d0048b5 Binary files /dev/null and b/developer/guide/img/building-5.png differ diff --git a/developer/guide/img/ide-setup-1.png b/developer/guide/img/ide-setup-1.png new file mode 100644 index 0000000..4ecbc40 Binary files /dev/null and b/developer/guide/img/ide-setup-1.png differ diff --git a/developer/guide/img/ide-setup-2.png b/developer/guide/img/ide-setup-2.png new file mode 100644 index 0000000..f26b138 Binary files /dev/null and b/developer/guide/img/ide-setup-2.png differ diff --git a/developer/guide/img/ide-setup-3.png b/developer/guide/img/ide-setup-3.png new file mode 100644 index 0000000..b284ce8 Binary files /dev/null and b/developer/guide/img/ide-setup-3.png differ diff --git a/developer/guide/img/ide-setup-4.png b/developer/guide/img/ide-setup-4.png new file mode 100644 index 0000000..818b6dd Binary files /dev/null and b/developer/guide/img/ide-setup-4.png differ diff --git a/developer/guide/img/ide-setup-5.png b/developer/guide/img/ide-setup-5.png new file mode 100644 index 0000000..6755828 Binary files /dev/null and b/developer/guide/img/ide-setup-5.png differ diff --git a/developer/guide/img/ide-setup-6.png b/developer/guide/img/ide-setup-6.png new file mode 100644 index 0000000..f91ebb0 Binary files /dev/null and b/developer/guide/img/ide-setup-6.png differ diff --git a/developer/guide/img/naming-convention.README b/developer/guide/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/developer/guide/img/naming-convention.README @@ -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 diff --git a/developer/guide/index.html b/developer/guide/index.html new file mode 100644 index 0000000..cc10044 --- /dev/null +++ b/developer/guide/index.html @@ -0,0 +1,598 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

9. Developer guide

+

In this section of the documentation, we aim to onboard developers onto the process of setting up a developer workstation, understanding the system architecture, contributing back to the project and so forth. Here is a brief overview of the content provided here:

+
    +
  • Architecture: - Here we outline the system architecture using ER Diagrams, Software Component Diagrams etc.
    • +
  • Prerequisites: - An overview of the software that needs to be installed before you can start.
    • +
  • Cloning: - In this section we cover how to make a local working copy on your own machine.
    • +
  • IDE Setup: - Here we walk through setting up your IDE.
    • +
  • Building: - This covers tasks related to building the application so you can test it in your browser.
    • +
  • Configuration: - This covers standard configuration tasks that need to be done once the site is brought online.
    • +
  • Design: - This section describes the visual design approach for the user interface.
    • +
  • Workflows: - Examples of typical workflows for adding features, fixing bugs etc.
    • +
  • Roadmap: - Here we outline future plans for the project.
    • +
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/guide/prerequisites/index.html b/developer/guide/prerequisites/index.html new file mode 100644 index 0000000..a4c2f49 --- /dev/null +++ b/developer/guide/prerequisites/index.html @@ -0,0 +1,588 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

11. Project prerequisites

+
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/guide/roadmap/index.html b/developer/guide/roadmap/index.html new file mode 100644 index 0000000..f46da5c --- /dev/null +++ b/developer/guide/roadmap/index.html @@ -0,0 +1,588 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

17. Project roadmap

+
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/guide/templates/commit-message-convention/index.html b/developer/guide/templates/commit-message-convention/index.html new file mode 100644 index 0000000..f1283c8 --- /dev/null +++ b/developer/guide/templates/commit-message-convention/index.html @@ -0,0 +1,588 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

20. Commit message convention

+
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/guide/templates/pull-request-template/index.html b/developer/guide/templates/pull-request-template/index.html new file mode 100644 index 0000000..f183526 --- /dev/null +++ b/developer/guide/templates/pull-request-template/index.html @@ -0,0 +1,588 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

19. Pull Request template

+
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/guide/workflows/index.html b/developer/guide/workflows/index.html new file mode 100644 index 0000000..c9802e4 --- /dev/null +++ b/developer/guide/workflows/index.html @@ -0,0 +1,685 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

18. Developer workflows

+ +

18.1 Adding a feature

+
    +
  • Create an Issue
    • +
  • Wait for it to be added to a Sprint
    • +
  • Functional Tests
    • +
  • Playwright Tests
    • +
  • Write end user documentation
    • +
+

18.2 Fixing a bug

+
    +
  • Claim an Issue
    • +
  • Wait for it to be added to a Sprint
    • +
  • Regression Test
    • +
  • Implement Fix
    • +
+

18.3 Make PR for feature/bug fix

+

18.3.1 Committing to project

+

Follow our Commit message conventions.

+

18.3.2 Pull request template

+

If it has related issues, add links to the issues(like #123) in the description. +Fill in the Pull Request template by check your case.

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/developer/img/naming-convention.README b/developer/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/developer/img/naming-convention.README @@ -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 diff --git a/developer/index.html b/developer/index.html new file mode 100644 index 0000000..106fc71 --- /dev/null +++ b/developer/index.html @@ -0,0 +1,1583 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

For Developers

+ + +

This is the homepage for all developer related documentation.

+
    +
  • The developer guide, which describes common workflows for developers in a tutorial format. This includes instructions on how to set up your developer environment, check out the code, run it locally etc.
    • +
  • The developer manual, which describes each python module and its classes, functions etc. This section is autogenerated.
    • +
  • The api guide, which describes common workflows for using the restful API.
    • +
  • The api manual, which describes each API endpoint and its parameters, return values etc. This section is autogenerated.
    • +
+ + + + + + +
+
+ + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/developer/manual/img/naming-convention.README b/developer/manual/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/developer/manual/img/naming-convention.README @@ -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 diff --git a/developer/manual/index.html b/developer/manual/index.html new file mode 100644 index 0000000..48c2330 --- /dev/null +++ b/developer/manual/index.html @@ -0,0 +1,1589 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Manual - Project Name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +
+

title: Automatically Generated Python Documentation +summary: DO NOT EDIT THIS FILE MANUALLY : It is created during the mkdocs build process +date: 2023-08-03

+
+

Python Reference Manual

+ + + + + + +
+
+ + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/devops/guide/img/naming-convention.README b/devops/guide/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/devops/guide/img/naming-convention.README @@ -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 diff --git a/devops/guide/index.html b/devops/guide/index.html new file mode 100644 index 0000000..4a4865a --- /dev/null +++ b/devops/guide/index.html @@ -0,0 +1,589 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

28. DevOps guide

+ +
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/devops/img/naming-convention.README b/devops/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/devops/img/naming-convention.README @@ -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 diff --git a/devops/index.html b/devops/index.html new file mode 100644 index 0000000..c2c4549 --- /dev/null +++ b/devops/index.html @@ -0,0 +1,1582 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

DevOps documentation

+ + +

This section contains all documentation relevant to DevOps procedures.

+

The devops content is divided into two sections:

+
    +
  • The devops guide, which describes common workflows for deployment and management of running instances in a tutorial format.
    • +
  • The devops manual, which provides links and references to deployment configuration files, frameworks and deployment systems used etc.
    • +
+ + + + + + +
+
+ + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/devops/manual/img/naming-convention.README b/devops/manual/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/devops/manual/img/naming-convention.README @@ -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 diff --git a/devops/manual/index.html b/devops/manual/index.html new file mode 100644 index 0000000..3a570d6 --- /dev/null +++ b/devops/manual/index.html @@ -0,0 +1,691 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

29. DevOps documentation

+ +

29.1 Containers used

+

29.2 SDLC

+

29.3 Continuous integration

+

29.4 Testing deployments

+

29.5 Backend orchestration

+

29.5.1 Deployments

+

29.5.2 Kubernetes

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/img/KartozaBackgroundBorder.png b/img/KartozaBackgroundBorder.png new file mode 100644 index 0000000..af4817f Binary files /dev/null and b/img/KartozaBackgroundBorder.png differ diff --git a/img/KartozaLogo-320x132.png b/img/KartozaLogo-320x132.png new file mode 100644 index 0000000..4d1a103 Binary files /dev/null and b/img/KartozaLogo-320x132.png differ diff --git a/img/favicon.ico b/img/favicon.ico new file mode 100644 index 0000000..48e801a Binary files /dev/null and b/img/favicon.ico differ diff --git a/img/logo.png b/img/logo.png new file mode 100644 index 0000000..48e801a Binary files /dev/null and b/img/logo.png differ diff --git a/img/logo.svg b/img/logo.svg new file mode 100644 index 0000000..35acd42 --- /dev/null +++ b/img/logo.svg @@ -0,0 +1,152 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/index.html b/index.html new file mode 100644 index 0000000..507009c --- /dev/null +++ b/index.html @@ -0,0 +1,1788 @@ + + + + + + + + + + + + + + + + + + + + + + + + GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

GEA AFFORESTATION

+ + +

Strapline

+

main_screenshot

+

Introduction

+ + + + +

Key concepts

+

A project (dashboard) is the most important feature of PROJECT_NAME. Projects +combine different elements (Reference datasets, indicators, and context layers) +and enable data visualization/analysis for all end users.

+

Context layers are geospatial layers used to contextualise the information +presented in a project.

+

Indicators layers derive from spreadsheets or other intelligence assets +harvested by the platform.

+

Widgets are visual components such as charts generated by performing data +analysis on country/regional levels and the indicator data.

+

Disclaimer

+
+The software provided by this project is provided 'as is'. All information provided +within the platform should be independently verified before using as the basis for +action. The contributors and developers of this platform take no responsibility +for any loss of revenue, life, physical harm or any other adverse outcome that may +occur as a result of the use of this platform. +
+ +

Purpose

+

Scope of project

+

Project roadmap

+

Project Roadmap +Project Roadmap

+ + +

Contributing

+

We would love to collaborate with you! But first, please read our contributor +guidelines which describe how to report +issues, plan and contribute feature additions etc.

+

Code of conduct

+

Our community in this project is aligned with our Code of +Conduct - please be sure to read and abide by that +document in all interactions with out community.

+

Diversity statement

+

This project welcomes and encourages participation by everyone.

+

No matter how you identify yourself or how others perceive you: we welcome you. +We welcome contributions from everyone as long as they interact constructively +with our community.

+

While much of the work for our project is technical in nature, we value and +encourage contributions from those with expertise in other areas, and welcome +them into our community.

+

Project partners

+ +

Project Partner 1 +Project Partner 1

+

Releases

+ +

GitHub releases page +Releases page

+ + + + + + + + + + + + + + + + + + + + +
Project Badges
LicenseVersionCommits
Issue TrackerClosed IssuesPull requests
+

Project chatroom

+ +

Chatroom

+

Contributor License Agreement (CLA)

+ +

Contributions to this project will be subject to our Contributor License Agreement

+

License

+

This project is open source, published under the AGPL-3. +You can read our license to find out what rights this license bestows to users and contributors.

+

License

+ +

Kartoza Logo

+ + + + + + +
+
+ + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 0000000..e2b584b Binary files /dev/null and b/objects.inv differ diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 0000000..52f4cd3 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"GEA AFFORESTATION","text":""},{"location":"#gea-afforestation","title":"GEA AFFORESTATION","text":"

Strapline

"},{"location":"#introduction","title":"Introduction","text":""},{"location":"#key-concepts","title":"Key concepts","text":"

A project (dashboard) is the most important feature of PROJECT_NAME. Projects combine different elements (Reference datasets, indicators, and context layers) and enable data visualization/analysis for all end users.

Context layers are geospatial layers used to contextualise the information presented in a project.

Indicators layers derive from spreadsheets or other intelligence assets harvested by the platform.

Widgets are visual components such as charts generated by performing data analysis on country/regional levels and the indicator data.

"},{"location":"#disclaimer","title":"Disclaimer","text":"The software provided by this project is provided 'as is'. All information provided within the platform should be independently verified before using as the basis for action. The contributors and developers of this platform take no responsibility for any loss of revenue, life, physical harm or any other adverse outcome that may occur as a result of the use of this platform."},{"location":"#purpose","title":"Purpose","text":""},{"location":"#scope-of-project","title":"Scope of project","text":""},{"location":"#project-roadmap","title":"Project roadmap","text":"

Project Roadmap

"},{"location":"#contributing","title":"Contributing","text":"

We would love to collaborate with you! But first, please read our contributor guidelines which describe how to report issues, plan and contribute feature additions etc.

"},{"location":"#code-of-conduct","title":"Code of conduct","text":"

Our community in this project is aligned with our Code of Conduct - please be sure to read and abide by that document in all interactions with out community.

"},{"location":"#diversity-statement","title":"Diversity statement","text":"

This project welcomes and encourages participation by everyone.

No matter how you identify yourself or how others perceive you: we welcome you. We welcome contributions from everyone as long as they interact constructively with our community.

While much of the work for our project is technical in nature, we value and encourage contributions from those with expertise in other areas, and welcome them into our community.

"},{"location":"#project-partners","title":"Project partners","text":"

Project Partner 1

"},{"location":"#releases","title":"Releases","text":"

GitHub releases page Releases page

Project Badges"},{"location":"#project-chatroom","title":"Project chatroom","text":"

Chatroom

"},{"location":"#contributor-license-agreement-cla","title":"Contributor License Agreement (CLA)","text":"

Contributions to this project will be subject to our Contributor License Agreement

"},{"location":"#license","title":"License","text":"

This project is open source, published under the AGPL-3. You can read our license to find out what rights this license bestows to users and contributors.

License

"},{"location":"about/","title":"GEA AFFORESTATION","text":""},{"location":"about/#about","title":"About","text":""},{"location":"about/#license","title":"License","text":"

Published under AGPL-3. See the full license text.

"},{"location":"about/#contributors","title":"Contributors","text":"Contributor GitHub Handle Tim Sutton timlinux Jeremy Prior Jeremy-Prior Ketan Bamniya ketankartoza"},{"location":"about/#project-fundersbackers","title":"Project funders/backers","text":"

This project was conceptualized and initially funded by FUNDER_1.

"},{"location":"about/#logos","title":"Logos","text":"

Another fine project contributed to by: Kartoza.com

"},{"location":"about/code-of-conduct/","title":"GEA AFFORESTATION","text":""},{"location":"about/code-of-conduct/#contributor-covenant-code-of-conduct","title":"Contributor covenant code of conduct","text":""},{"location":"about/code-of-conduct/#our-pledge","title":"Our pledge","text":"

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.

"},{"location":"about/code-of-conduct/#our-standards","title":"Our standards","text":"

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
"},{"location":"about/code-of-conduct/#our-responsibilities","title":"Our responsibilities","text":"

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.

"},{"location":"about/code-of-conduct/#scope","title":"Scope","text":"

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.

"},{"location":"about/code-of-conduct/#enforcement","title":"Enforcement","text":"

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.

"},{"location":"about/code-of-conduct/#attribution","title":"Attribution","text":"

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

"},{"location":"about/contributing/","title":"GEA AFFORESTATION","text":""},{"location":"about/contributing/#contributing-to-project_name","title":"Contributing to [PROJECT_NAME]","text":"

First off, thanks for taking the time to contribute! \ud83c\udf89 \ud83d\ude18 \u2728

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.

"},{"location":"about/contributing/#reporting-bugs","title":"Reporting bugs","text":"

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.
"},{"location":"about/contributing/#suggesting-enhancements","title":"Suggesting enhancements","text":"

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 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.
"},{"location":"about/contributing/#first-code-contribution","title":"First code contribution","text":"

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.
"},{"location":"about/contributing/#pull-requests","title":"Pull requests","text":""},{"location":"about/contributing/#development-workflow","title":"Development workflow","text":"
  • Set up your development environment
  • Make change from a right branch
  • Be sure the code passes tests
  • Make a pull request
"},{"location":"about/contributing/#development-environment","title":"Development environment","text":"
  • Prepare your machine and it's packages installed.
  • Checkout our repository
  • Install dependencies by pip install -r REQUIREMENTS-dev.txt
"},{"location":"about/contributing/#make-changes","title":"Make changes","text":""},{"location":"about/contributing/#checkout-a-branch","title":"Checkout a branch","text":"
  • main: PR Base branch.
  • production: lastest release branch with distribution files. Never make a PR on this.
  • gh-pages: API docs, examples and demo
"},{"location":"about/contributing/#check-code-style","title":"Check code style","text":"

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

"},{"location":"about/contributing/#test","title":"Test","text":"

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.

"},{"location":"about/contributing/#commit","title":"Commit","text":"

Follow our commit message conventions.

"},{"location":"about/contributing/#yes-pull-request","title":"Yes! Pull request","text":"

Make your pull request, then describe your changes.

"},{"location":"about/contributing/#title","title":"Title","text":"

Follow other PR title format on below.

    <Type>: Short Description (fix #111)\n    <Type>: Short Description (fix #123, #111, #122)\n    <Type>: Short Description (ref #111)\n
  • capitalize first letter of Type
  • use present tense: 'change' not 'changed' or 'changes'
"},{"location":"about/contributing/#description","title":"Description","text":"

If it has related issues, add links to the issues(like #123) in the description. Fill in the Pull Request Template by check your case.

"},{"location":"about/contributing/#code-of-conduct","title":"Code of conduct","text":"

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behaviour to tim@kartoza.com.

This guide is based on atom contributing guide, CocoaPods and ESLint

"},{"location":"about/disclaimer/","title":"GeoSight-OS Documentation Home","text":""},{"location":"about/disclaimer/#disclaimer","title":"Disclaimer","text":"

Disclaimer about project.

"},{"location":"about/license/","title":"License","text":""},{"location":"about/license/#gnu-affero-general-public-license","title":"GNU Affero General Public License","text":"

Version 3, 19 November 2007 Copyright \u00a9 2007 Free Software Foundation, Inc. <http://fsf.org/>

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

"},{"location":"about/license/#preamble","title":"Preamble","text":"

The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.

The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.

Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.

A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.

The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.

An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.

The precise terms and conditions for copying, distribution and modification follow.

"},{"location":"about/license/#terms-and-conditions","title":"TERMS AND CONDITIONS","text":""},{"location":"about/license/#0-definitions","title":"0. Definitions","text":"

\u201cThis License\u201d refers to version 3 of the GNU Affero General Public License.

\u201cCopyright\u201d also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.

\u201cThe Program\u201d refers to any copyrightable work licensed under this License. Each licensee is addressed as \u201cyou\u201d. \u201cLicensees\u201d and \u201crecipients\u201d may be individuals or organizations.

To \u201cmodify\u201d a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a \u201cmodified version\u201d of the earlier work or a work \u201cbased on\u201d the earlier work.

A \u201ccovered work\u201d means either the unmodified Program or a work based on the Program.

To \u201cpropagate\u201d a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.

To \u201cconvey\u201d a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays \u201cAppropriate Legal Notices\u201d to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.

"},{"location":"about/license/#1-source-code","title":"1. Source Code","text":"

The \u201csource code\u201d for a work means the preferred form of the work for making modifications to it. \u201cObject code\u201d means any non-source form of a work.

A \u201cStandard Interface\u201d means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

The \u201cSystem Libraries\u201d of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A \u201cMajor Component\u201d, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

The \u201cCorresponding Source\u201d for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.

The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.

The Corresponding Source for a work in source code form is that same work.

"},{"location":"about/license/#2-basic-permissions","title":"2. Basic Permissions","text":"

All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.

"},{"location":"about/license/#3-protecting-users-legal-rights-from-anti-circumvention-law","title":"3. Protecting Users' Legal Rights From Anti-Circumvention Law","text":"

No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.

When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.

"},{"location":"about/license/#4-conveying-verbatim-copies","title":"4. Conveying Verbatim Copies","text":"

You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.

"},{"location":"about/license/#5-conveying-modified-source-versions","title":"5. Conveying Modified Source Versions","text":"

You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:

  • a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
  • b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to \u201ckeep intact all notices\u201d.
  • c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
  • d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.

A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an \u201caggregate\u201d if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.

"},{"location":"about/license/#6-conveying-non-source-forms","title":"6. Conveying Non-Source Forms","text":"

You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:

  • a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
  • b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
  • c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
  • d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
  • e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.

A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.

A \u201cUser Product\u201d is either (1) a \u201cconsumer product\u201d, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, \u201cnormally used\u201d refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.

\u201cInstallation Information\u201d for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.

If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).

The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.

Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.

"},{"location":"about/license/#7-additional-terms","title":"7. Additional Terms","text":"

\u201cAdditional permissions\u201d are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:

  • a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
  • b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
  • c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
  • d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
  • e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
  • f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.

All other non-permissive additional terms are considered \u201cfurther restrictions\u201d within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.

Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.

"},{"location":"about/license/#8-termination","title":"8. Termination","text":"

You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.

"},{"location":"about/license/#9-acceptance-not-required-for-having-copies","title":"9. Acceptance Not Required for Having Copies","text":"

You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.

"},{"location":"about/license/#10-automatic-licensing-of-downstream-recipients","title":"10. Automatic Licensing of Downstream Recipients","text":"

Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.

An \u201centity transaction\u201d is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.

"},{"location":"about/license/#11-patents","title":"11. Patents","text":"

A \u201ccontributor\u201d is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's \u201ccontributor version\u201d.

A contributor's \u201cessential patent claims\u201d are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, \u201ccontrol\u201d includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.

In the following three paragraphs, a \u201cpatent license\u201d is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To \u201cgrant\u201d such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.

If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. \u201cKnowingly relying\u201d means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.

A patent license is \u201cdiscriminatory\u201d if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.

"},{"location":"about/license/#12-no-surrender-of-others-freedom","title":"12. No Surrender of Others' Freedom","text":"

If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.

"},{"location":"about/license/#13-remote-network-interaction-use-with-the-gnu-general-public-license","title":"13. Remote Network Interaction; Use with the GNU General Public License","text":"

Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.

Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License.

"},{"location":"about/license/#14-revised-versions-of-this-license","title":"14. Revised Versions of this License","text":"

The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License \u201cor any later version\u201d applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation.

If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.

Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.

"},{"location":"about/license/#15-disclaimer-of-warranty","title":"15. Disclaimer of Warranty","text":"

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \u201cAS IS\u201d WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

"},{"location":"about/license/#16-limitation-of-liability","title":"16. Limitation of Liability","text":"

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

"},{"location":"about/license/#17-interpretation-of-sections-15-and-16","title":"17. Interpretation of Sections 15 and 16","text":"

If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.

END OF TERMS AND CONDITIONS

"},{"location":"about/license/#how-to-apply-these-terms-to-your-new-programs","title":"How to Apply These Terms to Your New Programs","text":"

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the \u201ccopyright\u201d line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.>\nCopyright (C) <year>  <name of author>\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program.  If not, see <http://www.gnu.org/licenses/>.\n

Also add information on how to contact you by electronic and paper mail.

If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a \u201cSource\u201d link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.

You should also get your employer (if you work as a programmer) or school, if any, to sign a \u201ccopyright disclaimer\u201d for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see <http://www.gnu.org/licenses/>.

"},{"location":"about/running-instances/","title":"Examples of running instances","text":""},{"location":"administrator/","title":"GEA AFFORESTATION","text":""},{"location":"administrator/#for-administrators","title":"For administrators","text":"

This is the homepage for all administrator related documentation.

The content is divided into two sections:

  • The user guide, which describes common workflows for system administrators in a tutorial format.
  • The user manual, which describes each page of the admin user interface and what the various options on that page do.
"},{"location":"administrator/guide/","title":"PROJECT_TITLE","text":""},{"location":"administrator/guide/#administrator-guide","title":"Administrator guide","text":""},{"location":"administrator/manual/","title":"GEA AFFORESTATION","text":""},{"location":"administrator/manual/#administrator-manual","title":"Administrator manual","text":""},{"location":"developer/","title":"GEA AFFORESTATION","text":""},{"location":"developer/#for-developers","title":"For Developers","text":"

This is the homepage for all developer related documentation.

  • The developer guide, which describes common workflows for developers in a tutorial format. This includes instructions on how to set up your developer environment, check out the code, run it locally etc.
  • The developer manual, which describes each python module and its classes, functions etc. This section is autogenerated.
  • The api guide, which describes common workflows for using the restful API.
  • The api manual, which describes each API endpoint and its parameters, return values etc. This section is autogenerated.
"},{"location":"developer/api/","title":"GEA AFFORESTATION","text":""},{"location":"developer/api/#api-documentation","title":"API documentation","text":"

This is the homepage for all API related documentation.

  • The api guide, which describes common workflows for using the restful API.
  • The api manual, which describes each API endpoint and its parameters, return values etc. This section is autogenerated.
"},{"location":"developer/api/guide/","title":"GEA AFFORESTATION","text":""},{"location":"developer/api/guide/#api-guide","title":"API guide","text":""},{"location":"developer/api/manual/","title":"GEA AFFORESTATION","text":""},{"location":"developer/api/manual/#api-manual","title":"API manual","text":""},{"location":"developer/documentation/","title":"GeoSight-OS Documentation Home","text":""},{"location":"developer/documentation/#documentation","title":"Documentation","text":"

In this section of the documentation, we explain how to work with the documentation. The content is organised as follows:

  • Overview: Here we outline the documentation system and the standard workflows needed.
  • Context help: Here we outline the procedure for adding context help into the application and linking it to this documentation tree.
"},{"location":"developer/documentation/context-help/","title":"GeoSight-OS Documentation Context Help","text":""},{"location":"developer/documentation/context-help/#context-help","title":"Context Help","text":"

This section describes how the context help system works.

"},{"location":"developer/documentation/context-help/#overview","title":"Overview","text":"

The context help system provides an integration between the web application and the documentation.

The following concepts are used:

  • Site: This is the area for globally setting options relating to the context help system.
  • Blocks: These are small components displayed as blocks 1\ufe0f\u20e3 in the context help panel. Each block links to a section in the help documentation.
  • Pages: These are context help panels that are each linked to a particular URL in the application.
  • Page Blocks: These are links between pages and their constituent blocks. Each page can have many blocks and each block can be used in many pages.
"},{"location":"developer/documentation/context-help/#triggering-context-help","title":"Triggering context help","text":"

There are three ways to trigger context help:

  1. From the top nav bar 1\ufe0f\u20e3
  2. From the side panel 1\ufe0f\u20e3
  3. Next to widgets (not implemented yet)
"},{"location":"developer/documentation/context-help/#managing-context-help","title":"Managing context help","text":"

We manage the context help system from django admin. You need to be a staff user to do this and have been granted read/write/update permissions on the documentation center related tables. First open your user menu 1\ufe0f\u20e3 and then the Django Admin area 2\ufe0f\u20e3.

Next we can drill into the documentation center to see only the relevant admin activities 1\ufe0f\u20e3.

"},{"location":"developer/documentation/context-help/#site-preferences","title":"Site preferences","text":"

Our first activity is to edit the site preferences 1\ufe0f\u20e3.

Here our goal is to set the documentation base url for the context help system 1\ufe0f\u20e3. Use the URL for your documentation project i.e. https://unicef-drp.github.io/GeoSight-OS

"},{"location":"developer/documentation/context-help/#managing-pages","title":"Managing Pages","text":"

Next we need to create pages for each application end point where we want to include context sensitive help. First select pages 1\ufe0f\u20e3 from the documentation center menu:

Now you can edit an existing page 1\ufe0f\u20e3 or add a new one 2\ufe0f\u20e3:

The page properties you can set are going to determine how the context help panel appears in the application when triggering the help panel 1\ufe0f\u20e3:

Here is a detailed breakdown of the options:

1\ufe0f\u20e3 Name: A symbolic name for you to easily recognise what the context help is about

2\ufe0f\u20e3 Relative page url: This is the relative path to our application page (see underline in image above) e.g. /admin/importer/

3\ufe0f\u20e3 Url: This is where the documentation is, relative to the documentation base URL. For example if your docs base URL is at: https://unicef-drp.github.io/GeoSight-OS/ your help context document relative URL is /administrator/guide/. This will trigger the content panel link 3\ufe0f\u20e3 above to point to this page.

4\ufe0f\u20e3 Title: This will be displayed as 1\ufe0f\u20e3 above in the context help panel.

5\ufe0f\u20e3 Intro: This will be shown as lead-in text for the context help panel. See 2\ufe0f\u20e3 above.

On the page form you can also manage the blocks that appear in the context help.

"},{"location":"developer/documentation/context-help/#managing-blocks","title":"Managing blocks","text":"

You can view and manage existing blocks from the documentation center 1\ufe0f\u20e3 or add a new block 2\ufe0f\u20e3. We first create a block then go back to the page to add it to the page.

We can also create a new block directly from within a page.

  • To set a block link within the page use 1\ufe0f\u20e3
  • To set the order in which the block appears in the help panel use 2\ufe0f\u20e3. For ordering, lower number blocks will be listed before higher number blocks. It is up to you to ensure that each number used for ordering is unique.
  • To create a new block component for a page, use 3\ufe0f\u20e3 and then go and choose or create the actual block content.

Let's create a new block within the context of an existing page (this is the more normal workflow).

Because we have created it within the page form, the block form appears as a popup window. We can deal with the form components as follows:

  • The relative url 1\ufe0f\u20e3 (based on the the documentation site wide base url preference) to the documentation page
  • The anchor 2\ufe0f\u20e3 - this is optional and should point to a heading / subheading within the page if populated.
  • The title 3\ufe0f\u20e3 - title for the block. This is automatically filled in from the page unless you specify an override title. Normally you would leave this blank.
  • The thumbnail 4\ufe0f\u20e3 for the block. This is automatically linked to the first image below the anchor in the help document. Usually you would leave this blank.
  • Description 5\ufe0f\u20e3 for the block. This will be automatically populated from the first paragraph in the linked help documentation.

\u26a0\ufe0f As you can see, the block definition requires only minimal information - the URL and optionally the anchor on the page. Anything else you specify here will override information harvested from the page and likely make your documentation more difficult to maintain.

"},{"location":"developer/documentation/context-help/#page-blocks","title":"Page Blocks","text":"

Generally we will not directly use the PageBlocks management area - use the Page manager to add and remove blocks from your page.

"},{"location":"developer/documentation/context-help/#conclusion-and-notes","title":"Conclusion and notes","text":"

The system for context help has been designed in a generic way. That means that you can use any web site where you can reference content with page links and anchors.

\u26d4\ufe0f One word of caution. Do not use a web site as your documentation source if you do not control that site. The content from the help site is pulled directly into your application, which could put you in a compromising position if the content is not 'on message' for your organisation.

"},{"location":"developer/documentation/easy-workflow/","title":"GeoSight-OS Documentation Home","text":""},{"location":"developer/documentation/easy-workflow/#documentation-overview","title":"Documentation Overview","text":"

This document describes the easiest workflow for editing documentation.

Requirements:

  1. You need to have a GitHub account and be logged in to your account
  2. You need to have been given access to the repo by the repo manager
"},{"location":"developer/documentation/easy-workflow/#general-workflow","title":"General Workflow","text":"
  1. Go to the repo for the documentation.
  2. Press the . key on your keyboard.
  3. Select a file under the src folder to edit
  4. Press Ctrl-S to save your work.
  5. Go to the Source Control tab to commit your work.
  6. Add a short, descriptive comment describing your changes.
  7. Press the Commit and push button.
  8. Wait a few minutes and your changes should be published live.
"},{"location":"developer/documentation/easy-workflow/#adding-a-new-page","title":"Adding a new page","text":"

Any new page you create needs to be also added to mkdocs-base.yml so that it gets 'built. If you wish to build a page but not have it in the menu system, you can give it a blank menu description e.g.

# Pages to render but exclude from navigation\n- \"\": developer/guide/templates/pull-request-template.md \n

Conversely, to ensure it is shown in the menu, find the right place in the navigation tree and then insert it with a short descriptor. e.g.

# Pages to render and include from navigation\n- \"My Menu Item\": developer/guide/my-page.md \n
"},{"location":"developer/documentation/easy-workflow/#adding-images","title":"Adding images","text":"

You can easily upload images into the documentation sources and then add them to your document.

  1. Take an image using your favourite screenshot tool.
  2. Using your file manager, drag the file from your desktop into the img folder in the relevant part of the documentation you are working on.
  3. Shift+Drag the image into your markdown document.
  4. Edit the image description (the part in square brackets)
"},{"location":"developer/documentation/easy-workflow/#adding-links","title":"Adding links","text":"

You can add a link to any text by doing the following:

  1. Copy the link from your web browser to your clipboard.
  2. Either 2.1 Past the link directly into the document sources. 2.2 or, write some words ine square brackets and paste the link in round brackets after, VSCode will create a markdown formatted link.

This is a normal link https://staging-geosight.unitst.org/, this is a link.

The above in markdown:

This is a normal link https://staging-geosight.unitst.org/, [this is a link](https://staging-geosight.unitst.org/).\n
"},{"location":"developer/documentation/easy-workflow/#page-previews","title":"Page previews","text":"

You can easily preview the page you are working on by doing this:

  1. Press Ctl-Shift-V to open a preview of the page you are currently working in.
  2. Drag and drop the preview tab to the right side of the editing environment for a side-by-side view.
"},{"location":"developer/documentation/easy-workflow/#leaving-the-editor-viewer","title":"Leaving the editor viewer","text":"

How to leave the interactive editor.

  1. Click the 'hamburger' menu and go to the repository.
  2. Wait a few moments and the 'normal' GitHub page will load.
"},{"location":"developer/documentation/overview/","title":"GeoSight-OS Documentation Home","text":""},{"location":"developer/documentation/overview/#documentation-overview","title":"Documentation Overview","text":"

This section provides an overview of how the documentation system works.

"},{"location":"developer/documentation/overview/#background","title":"Background","text":"

Welcome to the instructions for those wishing to contribute to our documentation!

Our documentation system is based on the popular mkdocs system. We encourage you to read the upstream documentation from mkdocs for the finer details of how mkdocs. In particular, read this page before you get to work. Mkdocs is not hard, but it may feel initially a little different if you are used to creating your documentation in word.

We use mkdocs because it has some great and useful features. Most especially:

  • The code and the documentation are versioned together. This means that for whatever version of the code we have in our production release, we can be sure the documentation matches that release. We can also look back at changes over time through the version history when needed.
  • It can render beautiful static (not needing a backend server) web sites with great features like search, styling, intuitive navigation etc.
  • It can optionally render PDF documents from the same source markdown.
  • An ecosystem of plugins and themes makes mkdocs really flexible and extensible.
"},{"location":"developer/documentation/overview/#some-terminology","title":"Some terminology","text":"

In our documentation, we have organised the information using a specific nomenclature:

  • guide: A guide is a multi-step workflow / tutorial that leads your through common activities.
  • manual: A collection of documents that describe each part of the project in a matter of fact way without presupposing any specific workflow is being undertaken.

For each of the main topic areas (user, admin, developer, devops, api user) we provide guides and manuals as is appropriate.

"},{"location":"developer/documentation/overview/#organisation","title":"Organisation","text":"

The documentation is broadly organised in the following structure. This structure may change over time as sections are added / moved / removed:

src\n\u251c\u2500\u2500 about\n\u251c\u2500\u2500 administrator\n\u2502   \u251c\u2500\u2500 guide\n\u2502   \u2514\u2500\u2500 manual\n\u251c\u2500\u2500 developer\n\u2502   \u251c\u2500\u2500 documentation\n\u2502   \u251c\u2500\u2500 guide\n\u2502   \u2514\u2500\u2500 manual\n\u251c\u2500\u2500 devops\n\u2502   \u251c\u2500\u2500 guide\n\u2502   \u2514\u2500\u2500 manual\n\u2514\u2500\u2500 user\n    \u251c\u2500\u2500 api\n    \u251c\u2500\u2500 guide\n    \u251c\u2500\u2500 manual\n    \u2514\u2500\u2500 quickstart\n
"},{"location":"developer/documentation/overview/#file-naming-conventions","title":"File naming conventions","text":"

Please follow these conventions when writing your documentation:

  1. Write file names in all lower case, with hyphens separating words (no spaces). e.g. important-file.md not Important File.md or other deviations.
  2. Place the image files in the img folder adjacent to your content.
  3. Do not abbreviate any words in file names - but try to use terse, descriptive names.
  4. Place your content into the appropriate place as outline in the structure above.
  5. Each file should only one level one heading e.g. # Page title
  6. Headings and subheadings should be written as a terse phrase starting with a capital letter and subsequent words in lower case unless they are proper nouns. Do not place a colon after the heading.
  7. Use unicode number markers to reference numbers in images e.g. 1\ufe0f\u20e3
  8. Every heading / sub-heading should have a single line underneath it summarising the content that will follow. This sentence will be used in the help center in the application to give the user a reference point for the text that will follow. It also makes the help text more consistent and readable.
  9. For every section that images, the first image will be used as the thumbnail if the heading is referenced from the application.
"},{"location":"developer/documentation/overview/#contributing-to-the-documentation","title":"Contributing to the documentation","text":"

Note: The repo name in the images below is blurred out, you should work against the GeoRepo-OS repository when following these notes.

To start adding to the documentation navigate to the home page of the repository.

Once on the repository home page, 1\ufe0f\u20e3 click on Fork

On the next page 1\ufe0f\u20e3 Make sure your github account is selected as the owner and 2\ufe0f\u20e3 make sure the \"Copy the main branch only\" option is ticked as you will only need the main branch.

Once you have forked the repository, ensure that you are working in the main branch.

Once you are in your fork of the repository, click on . on your keyboard. This will open a web editor where you can begin adding to, or editing, the documentation.

Once the editor loads, you will be greeted by 1\ufe0f\u20e3 a preview of the project's README.txt. 2\ufe0f\u20e3 Click on the docs directory in the menu on the left, this will expand the directory. To confirm that you are working in the right branch 3\ufe0f\u20e3\ufe0f it will say main in the bottom left of the editor.

Once you have expanded the docs directory, 1\ufe0f\u20e3 click on the src directory. All sub-directories within the src directory contain the files that become the documentation. Each sub-directory contains an index.md file that is required for the building of the documentation and static site. If you add a new sub-directory into any folder it must also contain a populated index.md file.

Once you have chosen which section of documentation you would like to edit (e.g. user/guide/index.md), click on the file and it will open in the web editor.

Once you have the file open, you can start adding to the documentation using Markdown syntax. If you need to add images to your documentation, add them to the relative img sub-directories following the naming conventions set out in the naming-convention.README within the img folders.

When you have completed making additions to (or editing) the documentation, 1\ufe0f\u20e3 click on the source control tab then 2\ufe0f\u20e3 click on the plus symbol next to the changes you are finished with to stage them, 3\ufe0f\u20e3\ufe0f add a commit message that is associated with the work you have done, and the 4\ufe0f\u20e3 Click on Commit & Push

Once you have committed your changes, 1\ufe0f\u20e3 Click on the burger menu and then 2\ufe0f\u20e3 click on Go To Repository

Your fork of the repository will be opened in a new tab within your browser, navigate to that tab. Once there 1\ufe0f\u20e3 ensure you are on the main, you should see how many commits ahead of the upstream branch you are, then 2\ufe0f\u20e3 click on Contribute-> Open pull request.

On the next screen, 1\ufe0f\u20e3 give your pull request a meaningful title, 2\ufe0f\u20e3 give additional details regarding changes made in the larger text box, then 3\ufe0f\u20e3\ufe0f click on Create pull request. Also ensure you are creating a pull request to the upstream main branch from your main branch.

Once your pull request is opened you need to wait for it to be merged before you can open a new one.

"},{"location":"developer/documentation/overview/#creating-new-files","title":"Creating new files","text":""},{"location":"developer/documentation/overview/#page-metadata","title":"Page metadata","text":"

Whenever you create a new file, you should add the standard header to the top of the file:

---\ntitle: GeoRepo-OS Documentation \nsummary: GeoRepo is a UNICEF's geospatial web-based data storage and administrative boundary harmonization platform.\n    - Tim Sutton\n    - Dimas Tri Ciputra\n    - Danang Tri Massandy\ndate: 2023-08-03\ncopyright: Copyright 2023, Unicef\ncontact: georepo-no-reply@unicef.org\nlicense: 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.\n#context_id: 1234\n---\n

The summary can be updated to include your name for documents you contribute to.

The context_id is used to create a unique permalink to this document, and is optional. See further down in this document for more details.

"},{"location":"developer/documentation/overview/#navigation","title":"Navigation","text":"

All pages need to be added to the 'Nav' section of the mkdocs-base.yml file. This will ensure that it is available in the menus and that mkdocs renders without errors. For example, if you wish to add a new page to the User Guide area, in Nav you would add a line like this:

- \"Navigating the map\": users/guide/map-navigation.md

Sometimes you may not wish to have the new page displayed in the menu system (this can be useful when, for example, it is accessed via a link in another page. In these cases, leave the menu entry part blank e.g.

- \"\": users/guide/map-navigation.md

Mkdocs will still generate the page but it will not be added to the menu.

"},{"location":"developer/documentation/overview/#technical-notes","title":"Technical notes","text":""},{"location":"developer/documentation/overview/#working-locally","title":"Working locally","text":"

If you want to work with the documentation locally (i.e. directly on your PC), you need to follow this general process:

  1. Install python
  2. Install pip
  3. Install virtualenv (pip install virtualenv)
  4. Make the docs folder your working directory (cd docs)
  5. Create the virtual env in the docs folder (python -m venv env)
  6. Activate the venv (source env/bin/activate)
  7. Install the python modules listed in docs/requirements.txt (pip install -r requirements.txt)
  8. If you are on Linux or macOS, open the docs directory in a shell and run build-docs-html.sh
  9. In the docs directory, run mkdocs serve
  10. Open your web browser at https://localhost:8000 to view the rendered docs.

Note that mkdocs serve will dynamically re-render the docs any time you make a change. The process above is illustrated in the diagram below:

"},{"location":"developer/documentation/overview/#hooks","title":"Hooks","text":"

We implement two hooks (plugins for mkdocs that are invoked during the docs rendering process).

  • uuid_redirects_hook.py - this is used to handle page redirects from a uuid - see below for more details
  • python_manual_hook.py - this is used to auto-generate the reference guide for the python modules, classes and functions that make up the code base for this project.
"},{"location":"developer/documentation/overview/#permalinks-for-user-and-admin-docs","title":"Permalinks for user and admin docs","text":"

If you are a developer, you should be aware of the workflow for creating user and administrator documentation for each page you create.

Every page should have a help link on it that leads to the appropriate manual page. The workflow for doing this is:

  1. Generate a new page UUID using the provided python utility e.g. ./create-uuid.py
  2. Create a new page in the appropriate manual section e.g. docs/src/user/manual/login.md
  3. In the metadata section at the top of the page, add the context id e.g. context_id: V4cVEFd2TmwYJVb5HvWRwa
  4. In your django view, set up your help button to point to the site url and your context id. e.g. https://siteurl/V4cVEFd2TmwYJVb5HvWRwa

Whenever the user visits the page using the UUID URL, they will be redirected to the correct page e.g. https://siteurl/login/. This system protects us from file renaming and reorganising on the site, and ensures that the help link will always remain valid.

"},{"location":"developer/documentation/overview/#generating-pdfs","title":"Generating PDFS","text":"

To generate PDFS, cd into GEOREPO-OS/docs and then run the build-docs-pdf in a local terminal

"},{"location":"developer/documentation/overview/#generating-static-site","title":"Generating Static Site","text":"

To generate HTML, cd into GEOREPO-OS/docs and then run the build-docs-html in a local terminal. You can then run mkdocs serve to generate the static site on your local host, if there is a port conflict you can specify the port using the -a flag e.g mkdocs serve -a 127.0.0.1:8001.

"},{"location":"developer/guide/","title":"GEA AFFORESTATION","text":""},{"location":"developer/guide/#developer-guide","title":"Developer guide","text":"

In this section of the documentation, we aim to onboard developers onto the process of setting up a developer workstation, understanding the system architecture, contributing back to the project and so forth. Here is a brief overview of the content provided here:

  • Architecture: - Here we outline the system architecture using ER Diagrams, Software Component Diagrams etc.
  • Prerequisites: - An overview of the software that needs to be installed before you can start.
  • Cloning: - In this section we cover how to make a local working copy on your own machine.
  • IDE Setup: - Here we walk through setting up your IDE.
  • Building: - This covers tasks related to building the application so you can test it in your browser.
  • Configuration: - This covers standard configuration tasks that need to be done once the site is brought online.
  • Design: - This section describes the visual design approach for the user interface.
  • Workflows: - Examples of typical workflows for adding features, fixing bugs etc.
  • Roadmap: - Here we outline future plans for the project.
"},{"location":"developer/guide/architecture/","title":"GEA AFFORESTATION","text":""},{"location":"developer/guide/architecture/#system-architecture","title":"System architecture","text":"

In this section, we outline the system architecture using ER Diagrams, Software Component Diagrams etc. and key libraries / frameworks used in this project.

"},{"location":"developer/guide/architecture/#software-components-used","title":"Software components used","text":"

The following is a list, with brief descriptions, of the key components used in creating this platform. Please refer to their individual documentation for in-depth technical information.

Logo Name Notes Django Django makes it easier to build better web apps more quickly and with less code. ReactJS React lets you build user interfaces out of individual pieces called components. Create your own React components like Thumbnail, LikeButton, and Video. Then combine them into entire screens, pages, and apps. MUI Move faster with intuitive React UI tools. MUI offers a comprehensive suite of free UI tools to help you ship new features faster. Start with Material UI, our fully-loaded component library, or bring your own design system to our production-ready components. Docker Accelerate how you build, share, and run applications. Docker helps developers build, share, and run applications anywhere \u2014 without tedious environment configuration or management. Celery Celery is a simple, flexible, and reliable distributed system to process vast amounts of messages, while providing operations with the tools required to maintain such a system. It\u2019s a task queue with focus on real-time processing, while also supporting task scheduling. Celery Beat This extension enables you to store the periodic task schedule in your database. The periodic tasks can be managed from the Django Admin interface, where you can create, edit and delete periodic tasks and how often they should run. Django Rest Framework Django REST framework is a powerful and flexible toolkit for building Web APIs. MapLibre Open-source mapping libraries for web and mobile app developers. deck.gl is a WebGL-powered framework for visual exploratory data analysis of large datasets. PostGIS PostGIS extends the capabilities of the PostgreSQL relational database by adding support storing, indexing and querying geographic data. PostgreSQL PostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance. Tegola An open source vector tile server written in Go, Tegola takes geospatial data and slices it into vector tiles that can be efficiently delivered to any client. GDAL GDAL is a translator library for raster and vector geospatial data formats that is released under an MIT style Open Source License by the Open Source Geospatial Foundation. As a library, it presents a single raster abstract data model and single vector abstract data model to the calling application for all supported formats. It also comes with a variety of useful command line utilities for data translation and processing."},{"location":"developer/guide/architecture/#docker-components","title":"Docker components","text":"

The following diagram represents the docker containers, ports and volumes that are used to compose this platform.

"},{"location":"developer/guide/architecture/#er-diagram","title":"ER diagram","text":"

The following diagram represents all of the database entities that are created by the Django ORM (Object Relational Mapper). Right click the image and open it in its own tab to see it at full resolution.

\ud83e\udea7 If you already have all of the above criteria met, you can move on to Prerequisites to start the process of getting your local development environment set up.

"},{"location":"developer/guide/building/","title":"GEA AFFORESTATION","text":""},{"location":"developer/guide/building/#building-the-dev-environment","title":"Building the dev environment","text":"

This section covers the process of building and running the application from your IDE.

\ud83d\udea9 Make sure you have gone through the IDE Setup Process before following these notes.

Press Ctrl -> P 1\ufe0f\u20e3 and then >and search for Rebuild. Select Dev Containers: Rebuild and Reopen in Container2\ufe0f\u20e3. This will essentially mount your code tree inside a docker container and switch the development context of VSCode to be inside the container where all of the python etc. dependencies will be installed.

Once the task is running, a notification 1\ufe0f\u20e3 will be shown in the bottom right of the VSCode window. Clicking in the notification will show you the setup progress 2\ufe0f\u20e3. Note that this make take quite a while depending on the internet bandwidth you have and the CPU power of your machine.

"},{"location":"developer/guide/building/#open-a-dev-container-terminal","title":"Open a dev container terminal","text":"

Open terminal within the dev container context by clicking the +icon in the terminal pane 1\ufe0f\u20e3. The new terminal 2\ufe0f\u20e3 will show up in the list of running terminals 3\ufe0f\u20e3

"},{"location":"developer/guide/building/#install-frontend-libraries","title":"Install FrontEnd libraries","text":"
make frontend-dev\n
"},{"location":"developer/guide/building/#run-django-migration","title":"Run django migration","text":"
cd /home/web/project/django_project\npython manage.py migrate\n
"},{"location":"developer/guide/building/#create-super-user","title":"Create super user","text":"
cd /home/web/project/django_project\npython manage.py createsuperuser\n

During this process you will be prompted for your user name (defaults to root), email address and a password (which you need to confirm). Complete these as needed.

"},{"location":"developer/guide/building/#viewing-your-test-instance","title":"Viewing your test instance","text":"

After completing the steps above, you should have the development server available on port 2000 of your local host:

http://localhost:2000\n

The site will be rather bare bones since it will need to be configured in the admin area to set up the theme etc.

"},{"location":"developer/guide/cloning/","title":"GEA AFFORESTATION","text":""},{"location":"developer/guide/cloning/#checking-out-the-code","title":"Checking out the code","text":"

This section outlines the process of checking out the code for local development.

\ud83d\udea9 Make sure you have gone through the Prerequisites Section before following these notes.

Git Code check out [PROJECT_URL] 

git clone https://github.com/project-name/repository.git\n

\ud83d\udcd2Which branch to use?: Note that we deploy our staging work from the develop branch and our production environment from the main branch. If you are planning on contributing improvements to the project, please submit them against the develop branch.

\ud83e\udea7 Now that you have the code checked out, move on to the IDE Setup documentation.

"},{"location":"developer/guide/configuration/","title":"GEA AFFORESTATION","text":""},{"location":"developer/guide/configuration/#project-setup","title":"Project setup","text":""},{"location":"developer/guide/configuration/#clone-project_name-repository","title":"Clone [PROJECT_NAME] repository","text":"

This will clone the [PROJECT_NAME] repository to your machine 

git clone https://github.com/project/repository.git\n
"},{"location":"developer/guide/configuration/#set-up-the-project","title":"Set up the project","text":"

This will set up the [PROJECT_NAME] project on your machine

cd [PROJECT_NAME]\ncd deployment\ncp docker-compose.override.template.yml docker-compose.override.yml\ncp .template.env .env\ncd ..\nmake up\n

Wait until everything is done.

After everything is done, open up a web browser and go to http://127.0.0.1/ and the dashboard will open:

By Default, we can use the admin credential:

username : admin\npassword : admin\n
"},{"location":"developer/guide/configuration/#set-up-different-environment","title":"Set up different environment","text":"

To set up different environment, for example the Default credential, or the port of server, open deployment/.env. You can check the description below for each of variable.

COMPOSE_PROJECT_NAME=[PROJECT_NAME]\nNGINX_TAG=0.0.1  -> Change this for different nginx image\nDJANGO_TAG=0.0.1 -> Change this for different django image\nDJANGO_DEV_TAG=0.0.1 -> Change this for different django dev image\n\n# Environments\nDJANGO_SETTINGS_MODULE=core.settings.prod -> Change this to use different django config file\nADMIN_USERNAME=admin -> Default admin username \nADMIN_PASSWORD=admin -> Default admin password\nADMIN_EMAIL=admin@example.com -> Default admin email\nINITIAL_FIXTURES=True\nHTTP_PORT=80 -> Change the port of nginx\n\n# Database Environment\nDATABASE_NAME=django -> Default database name\nDATABASE_USERNAME=docker -> Default database username\nDATABASE_PASSWORD=docker -> Default database password\nDATABASE_HOST=db -> Default database host. Change this if you use cloud database or any new docker container.\nRABBITMQ_HOST=rabbitmq\n\n# Onedrive\nPUID=1000\nPGID=1000\n

After you change the desired variable and do make up. It will rerun the project with new environment.

"},{"location":"developer/guide/design/","title":"GEA AFFORESTATION","text":""},{"location":"developer/guide/design/#design","title":"Design","text":"

This section describes the visual design approach for the user interface.

"},{"location":"developer/guide/design/#design-sheet","title":"Design sheet","text":"

The following documents provide guidance for the standard visual design we use when building the site:

Preview Name Notes Colours Colour Palettes Buttons Designs for Buttons. Form Fields Form elements such as input boxes, select lists, radio buttons etc. Icons Standard iconography to be used in forms and views. Tables Design for tables and presentation of tabular data. Others Other user interface elements.

\ud83e\udea7 Once you have reviewed the design sheets, you can move on to our Roadmap.

"},{"location":"developer/guide/design/#wire-frame-model","title":"Wire-frame model","text":"

Wire-frame Model

"},{"location":"developer/guide/ide-setup/","title":"GEA AFFORESTATION","text":""},{"location":"developer/guide/ide-setup/#setting-up-your-ide","title":"Setting up your IDE","text":"

This section outlines the process for configuring your IDE for development.

\ud83d\udea9 Make sure you have gone through the Cloning Section before following these notes.

"},{"location":"developer/guide/ide-setup/#vs-code-setup","title":"VS Code setup","text":"

Open the project in VSCode (1\ufe0f\u20e3, 2\ufe0f\u20e3) by navigating the the place on your file system where you checked out the code in the pre-requisites step above (3\ufe0f\u20e3).

Accept the 'trust authors' prompt

"},{"location":"developer/guide/ide-setup/#copying-the-env","title":"Copying the .env","text":"

Copy the template.env to .env

Edit the .env file and change the

DJANGO_SETTINGS_MODULE=core.settings.prod\n

to

DJANGO_SETTINGS_MODULE=core.settings.dev\n

"},{"location":"developer/guide/ide-setup/#override-docker-configurations","title":"Override Docker configurations","text":"

We are going to copy the docker overrides template to a local file that will not be under version control.

Rename the file to docker-compose.override.yml

Initially you will not need to change anything in this file, though you may want to take a look through the various configurations provided here if you want to tweak your local setup.

Now that you have your IDE set up, we can move on to building the project.

"},{"location":"developer/guide/ide-setup/#using-pycharm","title":"Using PyCharm","text":"

\ud83d\udcd2 \u26d4\ufe0f This section needs to be reviewed and organised into our docs framework.

This section is for using pycharm.

Requirements:

  • Pycharm
  • Finished Setting up the project
"},{"location":"developer/guide/ide-setup/#setup-interpreter","title":"Setup interpreter","text":"

  1. Go to File -> Settings -> Project -> Project Interpreter. Then click on the cog -> add

  2. Go to the ssh interpreter tab and fill in the form as below

  3. Click next and fill in docker as the password

  4. Click next and change the interpreter as below, then click finish.

  5. After you click finish, it will show all of the packages like below.

  6. In current page, click path mappings, click + button and put local path to where the project (django-project folder) and remote path is like below. and click oK.

Now the interpreter is done. When we restart the machine, we need to do make up to run the project.

"},{"location":"developer/guide/ide-setup/#setup-run-configuration","title":"Setup run configuration","text":"

After the interpreter is done, we need configuration to run the project in development mode.

  1. Click \"Add configuration\" like in the cursor in the image below. (top-right)

  2. There will be a popup, and click +, then click django server like below

  3. It will show the form and fill like below.

  4. Don't click the OK yet, but click Environment Variables and add environments like below (by clicking + button).

  5. After that, click OK.

  6. Now we need to run the server by clicking go button in below image.

  7. When we click the go button, pycharm will run a process until like image below.

  8. Now it is done. We can access the development server in http://localhost:2000/

This development mode is DEBUG mode, and also whenever we change the code, the site will also change in runtime.

For more information how to set up on pycharm, please visit Using a Docker Compose-Based Python Interpreter in PyCharm

"},{"location":"developer/guide/ide-setup/#quick-setup-guide","title":"Quick setup guide","text":"

\u26d4\ufe0f\ud83d\udcd2 This content needs to be reviewed and moved to the readme.

"},{"location":"developer/guide/ide-setup/#production","title":"Production","text":"
git clone https://github.com/project-name/repository\ncd project-name/deployment\ndocker-compose up -d\n

The web will be available at http://127.0.0.1/

To stop containers:

docker-compose kill\n

To stop and delete containers:

docker-compose down\n
"},{"location":"developer/guide/ide-setup/#development","title":"Development","text":"
git clone https://github.com/project-name/repository\ncd project-name/deployment\ncp .template.env .env\ncp docker-compose.override.template.yml docker-compose.override.yml\n

After that,

  • open new terminal
  • on folder root of project, do
make frontend-dev\n

Wait until it is done when there is sentence \"webpack xxx compiled successfully in xxx ms\". After that, don't close the terminal. If it is accidentally closed, do make frontend-dev again

Next step: - Open new terminal - Do commands below 

make up\nmake dev\n

Wait until it is on.

The web can be accessed using http://localhost:2000/

If the web is taking long time to load, restart project-name_dev container by make dev-reload. The sequence should be make frontend-dev, after that run or restart project-name_dev.

To stop dev:

make dev-kill\n

To reload container:

make dev-reload\n
"},{"location":"developer/guide/prerequisites/","title":"GEA AFFORESTATION","text":""},{"location":"developer/guide/prerequisites/#project-prerequisites","title":"Project prerequisites","text":""},{"location":"developer/guide/roadmap/","title":"GEA AFFORESTATION","text":""},{"location":"developer/guide/roadmap/#project-roadmap","title":"Project roadmap","text":""},{"location":"developer/guide/workflows/","title":"GEA AFFORESTATION","text":""},{"location":"developer/guide/workflows/#developer-workflows","title":"Developer workflows","text":""},{"location":"developer/guide/workflows/#adding-a-feature","title":"Adding a feature","text":"
  • Create an Issue
  • Wait for it to be added to a Sprint
  • Functional Tests
  • Playwright Tests
  • Write end user documentation
"},{"location":"developer/guide/workflows/#fixing-a-bug","title":"Fixing a bug","text":"
  • Claim an Issue
  • Wait for it to be added to a Sprint
  • Regression Test
  • Implement Fix
"},{"location":"developer/guide/workflows/#make-pr-for-featurebug-fix","title":"Make PR for feature/bug fix","text":""},{"location":"developer/guide/workflows/#committing-to-project","title":"Committing to project","text":"

Follow our Commit message conventions.

"},{"location":"developer/guide/workflows/#pull-request-template","title":"Pull request template","text":"

If it has related issues, add links to the issues(like #123) in the description. Fill in the Pull Request template by check your case.

"},{"location":"developer/guide/templates/commit-message-convention/","title":"GEA AFFORESTATION","text":""},{"location":"developer/guide/templates/commit-message-convention/#commit-message-convention","title":"Commit message convention","text":""},{"location":"developer/guide/templates/pull-request-template/","title":"GEA AFFORESTATION","text":""},{"location":"developer/guide/templates/pull-request-template/#pull-request-template","title":"Pull Request template","text":""},{"location":"developer/manual/","title":"Manual","text":"

title: Automatically Generated Python Documentation summary: DO NOT EDIT THIS FILE MANUALLY : It is created during the mkdocs build process date: 2023-08-03

"},{"location":"developer/manual/#python-reference-manual","title":"Python Reference Manual","text":""},{"location":"devops/","title":"GEA AFFORESTATION","text":""},{"location":"devops/#devops-documentation","title":"DevOps documentation","text":"

This section contains all documentation relevant to DevOps procedures.

The devops content is divided into two sections:

  • The devops guide, which describes common workflows for deployment and management of running instances in a tutorial format.
  • The devops manual, which provides links and references to deployment configuration files, frameworks and deployment systems used etc.
"},{"location":"devops/guide/","title":"GEA AFFORESTATION","text":""},{"location":"devops/guide/#devops-guide","title":"DevOps guide","text":""},{"location":"devops/manual/","title":"GEA AFFORESTATION","text":""},{"location":"devops/manual/#devops-documentation","title":"DevOps documentation","text":""},{"location":"devops/manual/#containers-used","title":"Containers used","text":""},{"location":"devops/manual/#sdlc","title":"SDLC","text":""},{"location":"devops/manual/#continuous-integration","title":"Continuous integration","text":""},{"location":"devops/manual/#testing-deployments","title":"Testing deployments","text":""},{"location":"devops/manual/#backend-orchestration","title":"Backend orchestration","text":""},{"location":"devops/manual/#deployments","title":"Deployments","text":""},{"location":"devops/manual/#kubernetes","title":"Kubernetes","text":""},{"location":"user/","title":"GEA AFFORESTATION","text":""},{"location":"user/#user-documentation","title":"User documentation","text":"

This is the homepage for all user-related documentation.

The user content is divided into three sections:

  • The quickstart tutorial aims to get you familiar with the basics of the platform in around 5 minutes.
  • The user guide describes common workflows in a tutorial format.
  • The user manual describes each page of the user interface and what the various options on that page do.
"},{"location":"user/guide/","title":"GEA AFFORESTATION","text":""},{"location":"user/guide/#user-guide","title":"User guide","text":""},{"location":"user/manual/","title":"GEA AFFORESTATION","text":""},{"location":"user/manual/#user-manual","title":"User manual","text":"

This section of the documentation describes every page in the application and what the various components of that page do. The manual is intended to function as a reference for the application. For narrative / workflow based tutorials, you may prefer to work through our user guide.

"},{"location":"user/quickstart/","title":"GEA AFFORESTATION","text":""},{"location":"user/quickstart/#quickstart","title":"Quickstart","text":""},{"location":"user/quickstart/#installing-the-product","title":"Installing the product","text":""},{"location":"user/quickstart/#getting-started","title":"Getting started","text":""},{"location":"user/quickstart/#releases","title":"Releases","text":"

GitHub releases page Releases page

"}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 0000000..aa9df81 --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,193 @@ + + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + + None + 2024-07-14 + daily + + \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz new file mode 100644 index 0000000..617bd57 Binary files /dev/null and b/sitemap.xml.gz differ diff --git a/user/guide/img/naming-convention.README b/user/guide/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/user/guide/img/naming-convention.README @@ -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 diff --git a/user/guide/index.html b/user/guide/index.html new file mode 100644 index 0000000..270258a --- /dev/null +++ b/user/guide/index.html @@ -0,0 +1,588 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

5. User guide

+ +
+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/user/img/naming-convention.README b/user/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/user/img/naming-convention.README @@ -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 diff --git a/user/index.html b/user/index.html new file mode 100644 index 0000000..4569813 --- /dev/null +++ b/user/index.html @@ -0,0 +1,1581 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + + + + + + +
+ +
+ + + + +
+
+ + + +
+
+
+ + + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + + +

User documentation

+

This is the homepage for all user-related documentation.

+

The user content is divided into three sections:

+
    +
  • The quickstart tutorial aims to get you familiar with the basics of the platform in around 5 minutes.
    • +
  • The user guide describes common workflows in a tutorial format.
    • +
  • The user manual describes each page of the user interface and what the various options on that page do.
    • +
+ + + + + + +
+
+ + + + +
+ + + +
+ + + +
+
+
+
+ + + + + + + + + + + + + \ No newline at end of file diff --git a/user/manual/img/naming-convention.README b/user/manual/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/user/manual/img/naming-convention.README @@ -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 diff --git a/user/manual/index.html b/user/manual/index.html new file mode 100644 index 0000000..66fa29a --- /dev/null +++ b/user/manual/index.html @@ -0,0 +1,590 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+
+

6. User manual

+

This section of the documentation describes every page in the application and +what the various components of that page do. The manual is intended to function +as a reference for the application. For narrative / workflow based tutorials, +you may prefer to work through our user guide.

+
+
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file diff --git a/user/quickstart/img/naming-convention.README b/user/quickstart/img/naming-convention.README new file mode 100644 index 0000000..74a045a --- /dev/null +++ b/user/quickstart/img/naming-convention.README @@ -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 diff --git a/user/quickstart/index.html b/user/quickstart/index.html new file mode 100644 index 0000000..d3a1c86 --- /dev/null +++ b/user/quickstart/index.html @@ -0,0 +1,654 @@ + + + + + + + + + + + + + +GEA AFFORESTATION - Project Name + + + + + + + + + + + + + + + +
+
+
+ + +
+
+
+
+
+
+
+ +
+
+
+
+
+
+ +
+
+
+
+ +
+ +
+ +
+ +
+
+
+
+ + + + + + \ No newline at end of file