Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Changes to a couple of md files: from inline links to reference (footnote) links #1116

Merged
merged 10 commits into from
Jan 19, 2024
Merged

Changes to a couple of md files: from inline links to reference (footnote) links #1116

merged 10 commits into from
Jan 19, 2024

Conversation

cordovez
Copy link
Contributor

@cordovez cordovez commented Jan 18, 2024 •
edited by spwoodcock

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • [✅ ] 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Issue

Fixes #1100

Describe this PR

from inline links to reference (footnote) links

Screenshots

image.

Checklist before requesting a review

[optional] What gif best describes this PR or how it makes you feel?

🤓

@github-actions github-actions bot added documentation Improvements or additions to documentation devops labels Jan 18, 2024
@spwoodcock
Copy link
Member

Wow, this is awesome! Thanks so much @cordovez

I love that you did it all via script 😄

Just one small request:

  • The scripts dir is used for operational scripts, like those bundled into docker images or CI.
  • Could you please place the script under contrib/scripts/docs and I will merge.

@github-actions github-actions bot added contrib External contributions, or not related to core functionality and removed devops labels Jan 18, 2024
@cordovez
Copy link
Contributor Author

Hi Sam,
You are the victim of my first ever PR, so proceed with caution 🙈 . I was under the mistaken understanding that in requesting the pull that only edits to existing files would be compared, I didn't realise I was also including my script (otherwise I would have deleted before pushing). Also, there was a mismatch between my local and my remote which over-rode with a git merge --no-ff🙈 (which I have no idea about) but no changes were made to the files, only moving the script). Let me know if I've messed things up.

@spwoodcock
Copy link
Member

No worries at all - we have to learn somewhere!

Everything looks perfect, except one small file docs/XINSTALL copy.md 😄
Could you remove that one, commit, and push again & then we are all set

@cordovez
Copy link
Contributor Author

thanks for the heads up. Good night!

@spwoodcock spwoodcock merged commit 512b130 into hotosm:development Jan 19, 2024
2 checks passed
spwoodcock added a commit that referenced this pull request Jan 25, 2024
@spwoodcock @nrjadkry
@pre-commit-ci @NSUWAL123 @cordovez @Sujanadh @varun2948
Merge development --> staging (#1140)
1b9e8d0 
* build: remove ref to script_domain (move to separate repo)

* docs: add CNAME for custom docs domain

* build: move install.sh to fmtm-installer repo

* ci: remove install script from pr labeller

* docs: update info for using easy install script

* build: add justfile to repo for basic commands (#1098)

* build: add justfile to repo for basic commands

* build: remove Makefile, update Justfile

* build: add Justfile commands to clean databases

* docs: add Justfile to pr auto labeller

* refactor: organization routes/crud/schemas to use best practice (#1096)

* fix: use enums for HTTPStatus over codes

* refactor: update organization routes/crud/schemas best pracice

* added int to the union with str in org_exists functions

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: Niraj Adhikari <nrjadkry@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* feat: add basic user role support to backend (#1094)

* feat: update role enums: UserRole and ProjectRole

* feat: update DbUserRole model to use ProjectRole enum + comp key

* build: update base schema with new enum types

* fix: osm login methods to async

* feat: add basic roles: super admin & validator

* build: add migration for ProjectRole db enum type

* build: fix migrations with revert for projectrole

* build: fix enum migrations with intermediate varchar

* fix: handle invalid access tokens

* refactor: correct use of 403 http status over 401

* refactor: tidy minor code edits & lint fixes

* build: default to 4 workers on dev uvicorn container

* feat: add project_deps with get_project_by_id logic

* feat: add org_admin role to role deps

* fix: add user role to response /me for frontend

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* refactor: fix all pre-commit.ci linting errors (#1101)

* build: add migration for ProjectRole db enum type

* fix: database model backrefs for DbUserRole --> (DbProject/DbUser)

* fix: add debug user to bypass auth during tests

* refactor: simplify project deletion endpoint /project/{id}

* test: add test for project deletion endpoint

* refactor: rename upload_multi_polygon --> custom_task_boundaries

* ci: disable markdownlint rule MD033 (allow inline html img resize)

* docs: update docs home page to use ref links

* refactor: fix all linting errors for code

* ci: add CONTRIBUTING.md to prettier ignore list

* docs: fix linting errors for all markdown docs

* refactor: rename LICENSE --> LICENSE.md

* refactor: update badges in readme

* docs: add allcontributors to badge table

* ci: add LICENSE.md to markdownlint ignore

* ci: update markdownlint ignore syntax for ci

* ci: add LICENSE.md to prettier ignore

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* style: revert prettier changes to LICENSE.md

* ci: update pre-commit hook versions

* docs: fix markdown linting errors after update

* ci: disable hadolint until bundled binary

* ci: do not run shellcheck on contrib dir

* ci: ignore SC2188,SC2143 from shellcheck

* refactor: fix lint errors for all shell/bash scripts

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* fix: editable vector layer in ol for project creation (#1102)

* fix: backend import error fix

* fix (vectorLayer): style - conditionaly apply style on onModify present

* fix (splitTasks): map - edit added to splitted taskLayer

* fix (splitTasks): onModify - edited geojson set to dividedTaskGeojson state

* feat (createNewProject): only enable generate task btn if fgb file fetch is completed

* fix (createNewProject): splitTasks - logic fix

* fix (createNewProject): splitTasks - clear dividedTaskGeojson, splitTasksSelection, and dataExtractGeojson state on previous click

* feat (createNewProject): splitTasks - show loader and message until FGB file is fetching

* fix (createNewProject): taskSplit - display error on taskSplit fail

* fix vectorLayer: on modifyEnd return area of boundary as well

* fix button: loading text added to the button

* fix NewDefineAreaMap: removed data extraction in progress message from mapComponent

* fix (createNewProject): splitTasks - clearing state on step toggle remove

* fix (createNewProject): uploadArea - clear step4 & step5 step on AOI edit

* fix (createNewProject): dataExtract - generateTaskBTN added, disable next until taskGeneration success, state logic changed to track extractWays & featureType state validation

* fix (createNewProject): dataExtract - clear file state on reset click or if generateDataExtract click

* fix (createNewProject): customLine, customPolygon file state clear on AOI edit

* fix (createNewProject): dataExtract - clear previous extractGeojson, customLine, customPolygon on generate extract, btn disable state update

* fix: limit project area during create (#1109)

* fix: backend import error fix

* fix (vectorLayer): style - conditionaly apply style on onModify present

* fix (splitTasks): map - edit added to splitted taskLayer

* fix (splitTasks): onModify - edited geojson set to dividedTaskGeojson state

* feat (createNewProject): only enable generate task btn if fgb file fetch is completed

* fix (createNewProject): splitTasks - logic fix

* fix (createNewProject): splitTasks - clear dividedTaskGeojson, splitTasksSelection, and dataExtractGeojson state on previous click

* feat (createNewProject): splitTasks - show loader and message until FGB file is fetching

* fix (createNewProject): taskSplit - display error on taskSplit fail

* fix vectorLayer: on modifyEnd return area of boundary as well

* fix button: loading text added to the button

* fix NewDefineAreaMap: removed data extraction in progress message from mapComponent

* fix (createNewProject): splitTasks - clearing state on step toggle remove

* fix (createNewProject): uploadArea - clear step4 & step5 step on AOI edit

* fix (createNewProject): dataExtract - generateTaskBTN added, disable next until taskGeneration success, state logic changed to track extractWays & featureType state validation

* fix (createNewProject): dataExtract - clear file state on reset click or if generateDataExtract click

* fix (createNewProject): customLine, customPolygon file state clear on AOI edit

* fix (createNewProject): dataExtract - clear previous extractGeojson, customLine, customPolygon on generate extract, btn disable state update

* fix (createNewProject): uploadArea - warning & error shown if AOI exceeds 100 & 1000 sq.km respectively

* fix: use organization_manager table for org admins

* fix (newProjectDetails): searchInput - width increased (#1111)

* fix (frontend): projection validity check using coordinates of extent (#1112)

* docs: link to docs.hotosm.org for versioning info

* refactor: remove variable from docker install script

* ci: add py310 version to black code formatter

* docs: add link to pre-commit info in docs

* refactor: renaming for consistency with database (#1114)

* docs: update info about interactive api debugging port

* docs: add timestamp to doc pages via plugin

* build: add git-revision-date-localized plugin to docs group

* ci: docs build use image from gh-workflows

* build: upgrade osm-fieldwork-->0.4.1, osm-rawdata-->0.2.6

* Fix condition in elif statement for Feature type detection

* docs: update markdown links from inline to reference (footnote) style (#1116)

* Clean up links in contributing

* done: CONTRIBUTING.md

* done: INSTALL.md

* done: User-Mantual-For-Project-Managers.md

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Moving script file to a new directory

* move new script file to a new directory

* deleted superfluous XINSTALL copy.md

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* refactor: fix linting errors in project_crud

* feat: paginated submissions by project (#1110)

* feat: submission form fields for the submision table

* feat: paginated submissions by project

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* refactor: format submission_routes, remove dup import

* refactor: fix incorrect import from app.submission

* run pre-commit

---------

Co-authored-by: sujanadh <sujanadh07@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: spwoodcock <sam.woodcock@protonmail.com>

* fix: tile archive download for projects

* refactor: refactor odk appuser + qrcode function naming

* refactor: add metadata_username to odk qr code as test

* docs: use code of conduct on docs.hotosm.org

* fix divide by square on multipolygon geojson

* build: upgrade fmtm-splitter v0.2.6 --> v1.0.0rc0 (#1122)

* feat: add test coverage metric (#1129)

* build: add coverage.py to test dependencies

* docs: add dev info about coverage and profiling

* refactor: add doxygen output to gitignore

* build: add coverage-badge to test deps

* ci: update all workflows v1.4.2 --> v1.4.3

* ci: add coverage output during deploy pytest

* docs: add coverage stats to readme

* build: lock dependencies after merge coverage+fmtm-splitter

* build: add coverage files to gitignore

* ci: update pytest workflow test to use coverage

* ci: update all workflows v1.4.3 --> v1.4.4

* docs: add coverage link to docs page sidebar

* hotfix: geom type not populated with feature type

* ci: add simple smoke test to frontend deploy

* feat: organisation approval and admin endpoints (#1126)

* dependencies to cehck if user_exists

* endpoint to add organisation admin

* added approved field in organisation model

* fix: table name in migration file for organisations

* feat: organisations list api updated according to role

* feat: endpoint to approve organisations

* update: get organisation endpoint for filtering approval

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* added docstrings

* fix: pre-commit linting errors

* added docstring in user_deps file

* build: add default odk credentials to organisations

* build: merge migrations to organisations table

* refactor: fix linting errors

* refactor: remove subscription_tier field for orgs

* build: add public.organisation.approved field to base schema

* refactor: remove extra url field from DbOrganisation

* refactor: fix organizationModel dir --> organisation for import

* fix: remove router get_db global dependency (on routes)

* fix: use separate super_admin + check_super_admin deps

* fix: update org_admin to also allow super_admin

* refactor: remove missed log.warning from organisations endpoint

* fix: separate Depends from logic, working org approval

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: spwoodcock <sam.woodcock@protonmail.com>

* ci: fix frontend smoke test with .env file

* refactor: update project dashboard to use deps functions (#1127)

* Refactor: updated code to use deps function

* Created new deps function org_from_project

* fix: call check_org_exists logic from dependency

* refactor: var naming for consistency

---------

Co-authored-by: sujanadh <sujanadh07@gmail.com>
Co-authored-by: spwoodcock <sam.woodcock@protonmail.com>

* feat: paginated submissions per task (#1128)

* merge development

* feat: paginated submissions by task

---------

Co-authored-by: sujanadh <sujanadh07@gmail.com>

* fix: Depends usage for task_submissions endpoint

* build: replace project.private field with project.visibility enum (#1132)

* build: remove project_allowed_users table from db

* build: remove odk_central_src field from project table

* refactor: tidy/reorder project db model fields

* build: remove project.task_creation_mode field + enum

* build: replace project.private field with project.visibility enum

* fix: fix visibility migration column add syntax

* fix: apply migration to projects table

* build: fix check for projectvisibility type in migration

* ci: update workflows 1.4.5 for mkdocs --dirty

* ci: add sleep 5 for frontend smoke test dev startup

* ci: replace black with ruff-format

* build: update docker install script to handle root user

* docs: add info about using pyright for type checking

* ci: add tool.pyright config section to pyproject.toml

* fix: use optional params for extra AuthUser items

* refactor: fix return type for organisation url validator

* feat: added withcredential to include cookies on organization list api

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* build: add deployment container replicas and resource constraints (#1139)

* build: update backend image to use 1 uvicorn worker

* build: add api deploy replicas, remove container_name

* build: default to 1 local replica for easier debug

* docs: update container name for docker logs cmd

* fix: return of AuthUser during debug tests + linting

* feat: endpoint to return count of validated and mapped tasks (#1138)

* feat: new endpoint to return count of validated and mapped task

* refactor: move to tasks router + use pydantic model

* refactor: rename task_activity route --> tasks/activity

---------

Co-authored-by: sujanadh <sujanadh07@gmail.com>
Co-authored-by: spwoodcock <sam.woodcock@protonmail.com>

* feat: add AOI editing to map during project creation (#1135)

* feat (createNewProject): mapControlComponent - mapControlComponent including edit, undo added

* feat AssetModules: icons added

* feat (createNewProject): splitTasks - edit task on editBtn click

* fix codeRefactor: consoles removed

* fix mapControlComponent: undoIcon removed

* refactor(frontend): use absolute (aliased) imports over relative imports (#1136)

* fix: add vite alias @ for src dir

* refactor(frontend): replace all relative imports with @ alias

* build: add lint command to package.json (eslint)

* build: add @ alias to tsconfig for type imports

* refactor: fix all linting errors from eslint

* fix: browser console errors incorrect React usage

* fix: add axios interceptor withCredentials, plus API const

* refactor: fix remaining relative imports

* refactor: remove withCredentials from org endpoint (use interceptor)

---------

Co-authored-by: Niraj Adhikari <nrjadkry@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Nishit Suwal <81785002+NSUWAL123@users.noreply.github.com>
Co-authored-by: Niraj Adhikari <41701707+nrjadkry@users.noreply.github.com>
Co-authored-by: sujanadh <sujanadh07@gmail.com>
Co-authored-by: JC CorMan <cordovez@el-cordovez.com>
Co-authored-by: Sujan Adhikari <109404840+Sujanadh@users.noreply.github.com>
Co-authored-by: Deepak Pradhan <deepak.pradhan048@gmail.com>
Co-authored-by: Deepak Pradhan (Varun) <37866666+varun2948@users.noreply.github.com>
@spwoodcock
Copy link
Member

@all-contributors please add @cordovez for docs.

@allcontributors allcontributors bot mentioned this pull request Jan 30, 2024
Merged
@allcontributors AllContributors
Copy link
Contributor

@spwoodcock

I've put up a pull request to add @cordovez! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@cordovez cordovez

Labels
contrib External contributions, or not related to core functionality documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Convert markdown inline links to reference style links
2 participants
@cordovez @spwoodcock